Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add columns as parameter to get_dataframe #1057

Merged
merged 13 commits into from
Nov 17, 2024
Merged

Add columns as parameter to get_dataframe #1057

Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
d3ce9e6
Add columns as parameter to get_dataframe
BloodyHell Oct 22, 2024
80b40c5
Update HISTORY.rst
BloodyHell Oct 22, 2024
6b53725
Add columns param to get_ticker_price, including tests
Oct 23, 2024
013ee37
Update docstring
Oct 23, 2024
9277e33
Expand HISTORY.rst entry for 'columns' param
Oct 28, 2024
355c281
Update test descriptions and simplify some assertions
Oct 28, 2024
b9c1256
Add readme information
Oct 28, 2024
90c3538
docs: use end of day rather than IEX link for supported columns
hydrosquall Nov 2, 2024
f3b9e34
fix: apply black formatting
hydrosquall Nov 2, 2024
027bd0d
Fix link to docs
Nov 3, 2024
27e634d
Fix tests
Nov 3, 2024
67c5d4e
Merge remote-tracking branch 'origin/patch-1' into patch-1
Nov 3, 2024
803b2a9
Fix test_get_dataframe_with_volume_column, don't take the length of t…
Nov 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,9 @@ for each function for details.).
# Get latest prices, based on 3+ sources as JSON, sampled weekly
ticker_price = client.get_ticker_price("GOOGL", frequency="weekly")

# Get 1 min prices, including the "open", "close" and "volume" columns
ticker_price = client.get_ticker_price("GOOGL", frequency="1min", columns="open,close,volume")

# Get historical GOOGL prices from August 2017 as JSON, sampled daily
historical_prices = client.get_ticker_price("GOOGL",
fmt='json',
Expand Down Expand Up @@ -154,11 +157,21 @@ To receive results in ``pandas`` format, use the ``get_dataframe()`` method:
endDate='2018-05-31')


#Get a pd.DataFrame for a list of symbols for "close" and "volume" columns:
ticker_history = client.get_dataframe(['GOOGL', 'AAPL'],
frequency='weekly',
columns="close,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".

It's also possible to specify which columns you're interested in, for example: "open", "close", "low", "high" and "volume" (see https://www.tiingo.com/documentation/iex for future columns).
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the documentation endpoint for this link is https://www.tiingo.com/documentation/end-of-day rather than iex, but I can fix this after I merge your PR.


Cryptocurrency
-----------------

Expand Down