Add columns as parameter to get_dataframe #1057
Conversation
Allow the user to specify which columns to retrieve
|
Hi @BloodyHell , thanks for making this contribution. I see from the API docs that this is indeed a new request parameter. I have a few questions for you.
|
|
Fair points @hydrosquall.
|
There was a problem hiding this comment.
The change looks good, thank you for making this update + providing tests for both cases!
I've left some optional feedback if you'd like to make any last changes, but otherwise I can take care of that when we cut a new release.
If you'd like we can add a "volume" usage example to the README.rst at the repository root so people can make use of your parameter, but otherwise people will find out about this param from checking the docstring in their IDE.
|
@hydrosquall I've processed your comments and also expanded the README a little bit. Feel free to make changed to it or propose changes as you see fit. |
README.rst
Outdated
|
|
||
| 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). |
There was a problem hiding this comment.
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.
Got it. Requesting it as pandas always converts date to the index of the dataframe, thus it doesn't show up in the columns. Expanded the test_tiingo.py case for multiple columns in json format. |
# Conflicts: # README.rst
Allow the user to specify which columns to retrieve
🎉 Hello there 🎉! Thanks for taking the time to contribute to
Tiingo-Python!Summary of Changes
What is the motivation / context for this change?
-- I want to retrieve historical information including volume, but the official API specifies that to retrieve the volume column, it needs to be specified explicitly
Is this a bugfix or a feature?
-- Feature
What does this change / fix? (Link to Github Issue page if applicable)
-- It adds the option for users to include the 'columns' query parameter
Checklist
HISTORY.rstwith an entry summarizing your change