aljaz/tiingo-python
1
1
Fork 0
mirror of https://github.com/hydrosquall/tiingo-python.git synced 2025-12-18 20:24:19 +01:00
Code Issues Packages Projects Releases Wiki Activity

Basic documents for News API

Browse Source
This commit is contained in:
Cameron Yick
2017-09-17 15:27:46 -04:00
parent febffd76da
commit c69373732a
2 changed files with 14 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.rst
View File

@@ -25,7 +25,7 @@ Tiingo Python
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: 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. * Stock Market Ticker Closing Prices + Metadata. Data includes full distribution details and is validated using a proprietary EOD Price Engine.
* (Coming Soon): Curated news from top financial news sources + curated blogs. Stories are tagged by Tiingo's algorithms. * Curated news from top financial news sources + blogs. Stories are tagged with topic tags and relevant stock tickers by Tiingo's algorithms.
Usage Usage
@@ -64,7 +64,7 @@ Alternately, you may use a dictionary to customize/authorize your client.
# Initialize # Initialize
client = TiingoClient(config) client = TiingoClient(config)
Now you can use ``TiingoClient`` to make your API calls. (Other parameters are available for each endpoint beyond what has been written below, see the Tiingo website for full details). 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.).
.. code-block:: python .. code-block:: python
@@ -76,7 +76,11 @@ Now you can use ``TiingoClient`` to make your API calls. (Other parameters are a
ticker_price = client.get_ticker_price("GOOGL", frequency="weekly") ticker_price = client.get_ticker_price("GOOGL", frequency="weekly")
# Get news articles about given tickers or search terms from given domains # Get news articles about given tickers or search terms from given domains
# Coming soon! articles = client.get_news(tickers=['GOOGL', 'APPL'],
tags=['Laptops'],
sources=['washingtonpost.com'],
startDate='2017-01-01',
endDate='2017-08-31')
Further Docs Further Docs
@@ -91,7 +95,7 @@ Features
* Easy programmatic access to Tiingo API * Easy programmatic access to Tiingo API
* Reuse requests session across API calls for better performance * Reuse requests session across API calls for better performance
* Coming soon: * Coming soon:
* Client-side validation of tickers, to save your API calls! * Client-side validation of tickers
* Data validation of returned responses * Data validation of returned responses
* Case insensitivity for ticker names * Case insensitivity for ticker names

8
docs/usage.rst
View File

@@ -43,8 +43,12 @@ Now you can use ``TiingoClient`` to make your API calls. (Other parameters are a
# Get latest prices, based on 3+ sources, as CSV or JSON, sampled weekly # Get latest prices, based on 3+ sources, as CSV or JSON, sampled weekly
ticker_price = client.get_ticker_price("GOOGL", frequency="weekly") ticker_price = client.get_ticker_price("GOOGL", frequency="weekly")
# Get news articles about given tickers or search terms from given domains # Get news articles about given tickers. Requires Pro account.
# Coming soon! articles = client.get_news(tickers=['GOOGL', 'APPL'],
tags=['Bitcoin'],
sources=['washingtonpost.com'],
startDate='2017-01-01',
endDate='2017-08-31')
Further Docs Further Docs
-------- --------