Skip to main content

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, end_date: Optional[str] = None, source: str = "YahooFinance", verbose: bool = False)

Parameters​

NameTypeDescriptionDefaultOptional
to_symbolstrThe from currency symbol. Ex: USD, EUR, GBP, YENNoneFalse
from_symbolstrThe from currency symbol. Ex: USD, EUR, GBP, YENNoneFalse
resolutionstrThe resolution for the data, by default "d"dTrue
intervalstrWhat interval to get data for, by default "1day"1dayTrue
start_dateOptional[str]When to begin loading in data, by default last_year.strftime("%Y-%m-%d")NoneTrue
end_dateOptional[str]When to end loading in data, by default NoneNoneTrue
sourcestrWhere to get data from, by default "YahooFinance"YahooFinanceTrue
verboseboolDisplay verbose information on what was the pair that was loaded, by default TrueFalseTrue

Returns​

TypeDescription
pd.DataFrameThe loaded data

Examples​

from openbb_terminal.sdk import openbb
openbb.forex.load(from_symbol="EUR", to_symbol="USD", start_date="2020-11-30", end_date="2022-12-01")