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

Update README.rst with suggested modifications

Browse Source 
Updated with some cryptocurrency examples as requested in #520. I also resolved some capitalization problems in the code, e.g. CLIENT.method rather than client.method as the code example dictates.
This commit is contained in:
GenusGeoff
2021-03-01 20:08:52 -05:00
committed by GitHub
parent ea6a2986d6
commit 214a03a1ef
1 changed files with 23 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
README.rst
View File

@@ -78,7 +78,8 @@ Alternately, you may use a dictionary to customize/authorize your client.
# 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.).
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
@@ -108,11 +109,11 @@ Now you can use ``TiingoClient`` to make your API calls. (Other parameters are a
# Get definitions for fields available in the fundamentals-api, ticker is
# optional
definitions = get_fundamentals_definitions('GOOGL')
definitions = client.get_fundamentals_definitions('GOOGL')
# Get fundamentals which require daily-updated (like marketCap). A start-
# and end-date can be passed. If omited, will get all available data.
fundamentals_daily = CLIENT.get_fundamentals_daily('GOOGL',
fundamentals_daily = client.get_fundamentals_daily('GOOGL',
startDate='2020-01-01',
endDate='2020-12-31')
@@ -120,7 +121,7 @@ Now you can use ``TiingoClient`` to make your API calls. (Other parameters are a
# daily-fundamentals. asReported can be set to get the data exactly like
# it was reported to SEC. Set to False if you want to get data containing
# corrections
fundamentals_stmnts = CLIENT.get_fundamentals_statements('GOOGL',
fundamentals_stmnts = client.get_fundamentals_statements('GOOGL',
startDate='2020-01-01',
endDate='2020-12-31',
asReported=True)
@@ -152,7 +153,24 @@ To receive results in ``pandas`` format, use the ``get_dataframe()`` method:
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".
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".
.. code-block:: python
# You can obtain cryptocurrency metadata using the following method.
client.get_crypto_metadata(['BTCUSD'], fmt='json')
# You can obtain top-of-book cryptocurrency quotes from the ``get_crypto_top_of_book()`` method.
# NOTE: Crypto symbol MUST be encapsulated in brackets as a Python list!
crypto_price = client.get_crypto_top_of_book(['BTCUSD'])``
# You can obtain historical Cryptocurrency price quotes from the get_crypto_price_history() method.
# NOTE: Crypto symbol MUST be encapsulated in brackets as a Python list!
client.get_crypto_price_history(tickers = ['BTCUSD'], startDate='2020-12-2', endDate='2020-12-3', resampleFreq='1Hour')
Further Docs
-------------