jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-28 13:01:38 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
59fcce4466fcf7322f1e5520a2dcd652f9d12ea0
OpenBB/website/versioned_docs/version-v3/sdk/reference/forex/load.md
Theodore Aptekarev f72bc8ccec Add Versioned Documentation (#5470) 
* Adding versioning to docs

---------

Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
Co-authored-by: tehcoderer <me@tehcoderer.com>
2023-09-29 11:49:05 +02:00

1.3 KiB
Vendored
Raw Blame History

title, description
title description
load OpenBB SDK Function

load

Load forex for two given symbols.

Source Code: [link]

openbb.forex.load(to_symbol: str, from_symbol: str, resolution: str = "d", interval: str = "1day", start_date: Optional[str] = None, source: str = "YahooFinance", verbose: bool = False)

Parameters

Name Type Description Default Optional
to_symbol str The from currency symbol. Ex: USD, EUR, GBP, YEN None False
from_symbol str The from currency symbol. Ex: USD, EUR, GBP, YEN None False
resolution str The resolution for the data, by default "d" d True
interval str What interval to get data for, by default "1day" 1day True
start_date Optional[str] When to begin loading in data, by default last_year.strftime("%Y-%m-%d") None True
source str Where to get data from, by default "YahooFinance" YahooFinance True
verbose bool Display verbose information on what was the pair that was loaded, by default True False True

Returns

Type Description
pd.DataFrame The loaded data