mirror of
https://github.com/hydrosquall/tiingo-python.git
synced 2025-12-17 20:04:19 +01:00
Expand README with Example Usage
This commit is contained in:
56
README.rst
56
README.rst
@@ -18,24 +18,66 @@ Tiingo Python
|
||||
:alt: Updates
|
||||
|
||||
|
||||
Tiingo is a financial data platform that makes high quality financial data more accessible to institutions and users alike.
|
||||
Tiingo is a financial data platform that makes high quality financial tools available to all. It has a RESTful and Real-Time API. Presently, the API includes support for the following endpoints:
|
||||
|
||||
The official Tiingo API docs are located here_.
|
||||
|
||||
.. _here : https://api.tiingo.com
|
||||
* Stock Market Ticker Closing Prices + Metadata. Data includes full distribution details and is validated using a proprietary EOD Price Engine.
|
||||
* Mutual Funds Metadata + Metrics updated daily. Supports over 26,500 Mutual Funds and ETFs.
|
||||
* (Coming Soon): Curated news from top financial news sources + curated blogs. Stories are tagged by Tiingo's algorithms.
|
||||
|
||||
|
||||
* Free software: MIT license
|
||||
* Documentation (Under Construction): https://tiingo.readthedocs.io.
|
||||
Usage
|
||||
--------
|
||||
|
||||
First, install the library from PyPi
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
pip install tiingo
|
||||
|
||||
Then, use the TiingoClient to make your API calls easier! (Other parameters are available for each endpoint beyond what has been written below, see docs for full details.)
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
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.
|
||||
|
||||
# With environment variable
|
||||
client = TiingoClient()
|
||||
# With hardcoded dictionary key
|
||||
client = TiingoClient({'api_key': "MY_SECRET_API_KEY"})
|
||||
|
||||
# Get Ticker
|
||||
# See official docs for list of all supported tickers + date ranges
|
||||
ticker_metadata = client.get_ticker_metadata("GOOGL")
|
||||
|
||||
# Get latest prices, based on 3+ sources, as CSV or JSON, sampled weekly
|
||||
ticker_price = client.get_ticker_price("GOOGL", frequency="weekly")
|
||||
|
||||
# Get mutual fund metadata
|
||||
fund_metadata = client.get_fund_metadata("VFINX")
|
||||
|
||||
# Get mutual fund Expenses and Shareholder Fee Data for June 2017
|
||||
fund_metrics = client.get_fund_metrics("VFINX", "2017-06-01", "2017-06-30")
|
||||
|
||||
# Get news articles about given tickers or search terms from given domains
|
||||
# Coming soon!
|
||||
|
||||
* Official Tiingo Documentation: https://api.tiingo.com
|
||||
* Tiingo-Pyhon Documentation (Under Construction): https://tiingo-python.readthedocs.io.
|
||||
|
||||
Features
|
||||
--------
|
||||
|
||||
* TODO
|
||||
* Easy programmatic access to Tiingo API
|
||||
* Coming soon: client-side validation of tickers, to save your API calls!
|
||||
* Free software: MIT license
|
||||
|
||||
Credits
|
||||
---------
|
||||
|
||||
* Many thanks to Rishi Singh for creating Tiingo, and spreading the ethos of generosity.
|
||||
|
||||
This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
|
||||
|
||||
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
|
||||
|
||||
Reference in New Issue
Block a user