addisonlynch / iexfinance

Python SDK for IEX Cloud
https://addisonlynch.github.io/iexfinance
Apache License 2.0
650 stars 136 forks source link

get_historical_data() documentation #176

Open rsheftel opened 5 years ago

rsheftel commented 5 years ago

The get_historical_data() function ( https://addisonlynch.github.io/iexfinance/stable/stocks.html#daily ) appears to return the adjusted data as defined in the IEX docs ( https://iexcloud.io/docs/api/#historical-prices ).

I would suggest in the function documentation to make clear that the returned values are the adjusted values.

I would also request an option to return the un-adjusted values as well because IEX only adjusts for splits and not dividends which is unusual and unexpected behavior.

addisonlynch commented 5 years ago

Thanks. Perhaps it would be better to return the unadjusted values by default given the unusual behavior you pointed out. I will also add a parameter (adjusted) to this function.

rsheftel commented 3 years ago

It looks like in the new v0.5 release you now return the entire data provided by IEX including raw un-adjusted and adjusted data. You can close this now.