jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-08 18:32:21 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
4e6a2fb5648d7e8ee4fdb31d1ce6ffddbaf701bf
OpenBB/website/content/api/forex/hist/_index.md
Colin Delahunty 0b33cb45f8 Adds auto yaml generation (#2587) 
* Began working on docs creator

* Added fixes

* More

* More

* Adding autogen_try.py for OpenBB API doc generation

* OpenBB API docs gen try

* Fixed

* Added fixes

* Added fixes

* subs -> sub

* Updated docs

* Updated docs

Co-authored-by: Chavithra PARANA <chavithra@gmail.com>
2022-09-23 16:43:34 +01:00

665 B
Vendored
Raw Blame History

Get underlying data

forex.hist(to_symbol: str = 'USD', from_symbol: str = 'EUR', resolution: str = 'd', interval: int = 5, start_date: str = '') -> pandas.core.frame.DataFrame

Get historical forex data.

Parameters
----------
to_symbol : str
    To forex symbol
from_symbol : str
    From forex symbol
resolution : str, optional
    Resolution of data.  Can be "i", "d", "w", "m" for intraday, daily, weekly or monthly
interval : int, optional
    Interval for intraday data
start_date : str, optional
    Start date for data.

Returns
-------
pd.DataFrame
    Historical data for forex pair