jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-28 21:12:16 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
aafb5a52ff1b71fa82f8a175b76b0bba1bf66c21
OpenBB/website/content/api/forex/load/_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

717 B
Vendored
Raw Blame History

Get underlying data

forex.load(to_symbol: str, from_symbol: str, resolution: str = 'd', interval: str = '1day', start_date: str = '2021-09-23', source: str = 'YahooFinance') -> pandas.core.frame.DataFrame

Loads forex for two given symbols

Parameters
----------
to_symbol : str
    The from currency symbol. Ex: USD, EUR, GBP, YEN
from_symbol: str
    The from currency symbol. Ex: USD, EUR, GBP, YEN
resolution: str
    The resolution for the data
interval: str
    What interval to get data for
start_date: str
    When to begin loading in data
source: str
    Where to get data from

Returns
-------
pd.DataFrame
    The loaded data