jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-06 01:12:27 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
8731fbd692f911e10778207df26276fcce715e21
OpenBB/website/content/api/forex/load/_index.md
Colin Delahunty 8731fbd692 Auto Generate API Documentation (#2360) 
* Started auto doc generation

* Created a markdown document

* Added test changed to md

* Created working version of new documentation

* Made requested changes

* Generate docs for all

Co-authored-by: minhhoang1023 <40023817+minhhoang1023@users.noreply.github.com>
2022-09-20 19:15:54 +01:00

730 B
Vendored
Raw Blame History

forex.load

Get underlying data

###forex.load(to_symbol: str, from_symbol: str, resolution: str = 'd', interval: str = '1day', start_date: str = '2021-09-20', 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