Python REST Client for interacting with the Tiingo Financial Data API
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Add PR Template for Tiingo Jul 7, 2018
docs
tests Updated frequency error check Jul 4, 2018
tiingo Minor version bump Jul 7, 2018
tools
.editorconfig Initial commit Aug 25, 2017
.gitignore Add method for listing available tickers Sep 17, 2017
.travis.yml Fix #126: Cache Pip Dependencies Jul 5, 2018
AUTHORS.rst Requested changes Jul 4, 2018
CONTRIBUTING.rst Add New Release notes Jul 7, 2018
HISTORY.rst
LICENSE Initial commit Aug 25, 2017
MANIFEST.in
Makefile
README.rst Initial commit Jul 4, 2018
RELEASE.rst Add New Release notes Jul 7, 2018
requirements_dev.txt Merge pull request #188 from hydrosquall/pyup-update-pytest-3.8.2-to-… Nov 20, 2018
setup.cfg
setup.py
tox.ini Initial commit Aug 25, 2017

README.rst

Tiingo Python

https://img.shields.io/pypi/v/tiingo.svg?maxAge=600 Coverage https://img.shields.io/travis/hydrosquall/tiingo-python.svg?maxAge=600 Documentation Status Updates

Tiingo is a financial data platform that makes high quality financial tools available to all. Tiingo has a REST and Real-Time Data API, which this library helps you to access. Presently, the API includes support for the following endpoints:

  • Stock Market Ticker Closing Prices + Metadata. Data includes full distribution details and is validated using a proprietary EOD Price Engine.
  • Curated news from top financial news sources + blogs. Stories are tagged with topic tags and relevant stock tickers by Tiingo's algorithms.

Usage

First, install the library from PyPi:

pip install tiingo

If you prefer to receive your results in pandas DataFrame or Series format, and you do not already have pandas installed, install it as an optional dependency:

pip install tiingo[pandas]

Next, initialize your client. It is recommended to use an environment variable to initialize your client for convenience.

from tiingo import TiingoClient
# Set TIINGO_API_KEY in your environment variables in your .bash_profile, OR
# pass a dictionary with 'api_key' as a key into the TiingoClient.

client = TiingoClient()

Alternately, you may use a dictionary to customize/authorize your client.

config = {}

# To reuse the same HTTP Session across API calls (and have better performance), include a session key.
config['session'] = True

# If you don't have your API key as an environment variable,
# pass it in via a configuration dictionary.
config['api_key'] = "MY_SECRET_API_KEY"

# Initialize
client = TiingoClient(config)

Now you can use TiingoClient to make your API calls. (Other parameters are available for each endpoint beyond what is used in the below examples, inspect the docstring for each function for details.).

# Get Ticker
ticker_metadata = client.get_ticker_metadata("GOOGL")

# Get latest prices, based on 3+ sources as JSON, sampled weekly
ticker_price = client.get_ticker_price("GOOGL", frequency="weekly")

# Get historical GOOGL prices from August 2017 as JSON, sampled daily
historical_prices = client.get_ticker_price("GOOGL",
                                            fmt='json',
                                            startDate='2017-08-01',
                                            endDate='2017-08-31',
                                            frequency='daily')

# Check what tickers are available, as well as metadata about each ticker
# including supported currency, exchange, and available start/end dates.
tickers = client.list_stock_tickers()

# Get news articles about given tickers or search terms from given domains
articles = client.get_news(tickers=['GOOGL', 'AAPL'],
                            tags=['Laptops'],
                            sources=['washingtonpost.com'],
                            startDate='2017-01-01',
                            endDate='2017-08-31')

To receive results in pandas format, use the get_dataframe() method:

#Get a pd.DataFrame of the price history of a single symbol (default is daily):
ticker_history = client.get_dataframe("GOOGL")

#The method returns all of the available information on a symbol, such as open, high, low, close,
#adjusted close, etc.  This page in the tiingo api documentation lists the available information on each
#symbol: https://api.tiingo.com/docs/tiingo/daily#priceData.

#Frequencies and start and end dates can be specified similarly to the json method above.

#Get a pd.Series of only one column of the available response data by specifying one of the valid the
#'metric_name' parameters:
ticker_history = client.get_dataframe("GOOGL", metric_name='adjClose')

#Get a pd.DataFrame for a list of symbols for a specified metric_name (default is adjClose if no
#metric_name is specified):
ticker_history = client.get_dataframe(['GOOGL', 'AAPL'],
                                      frequency='weekly',
                                      metric_name='volume',
                                      startDate='2017-01-01',
                                      endDate='2018-05-31')

You can specify any of the end of day frequencies (daily, weekly, monthly, and annually) or any intraday frequency for both the get_ticker_price and get_dataframe methods. Weekly frequencies resample to the end of day on Friday, monthly frequencies resample to the last day of the month, and annually frequencies resample to the end of day on 12-31 of each year. The intraday frequencies are specified using an integer followed by "Min" or "Hour", for example "30Min" or "1Hour".

Further Docs

Features

  • Easy programmatic access to Tiingo API
  • Reuse requests session across API calls for better performance
  • On most methods, pass in fmt="object" as a keyword to have your responses come back as NamedTuples, which should have a lower memory impact than regular Python dictionaries.

Roadmap:

  • Client-side validation of tickers
  • Data validation of returned responses
  • Case insensitivity for ticker names
  • More documentation / code examples

Feel free to file a PR that implements any of the above items.

Related Projects:

  • Riingo : Client for Tiingo in the R Programming Language

Credits

  • Many thanks to Rishi Singh for creating Tiingo.

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.