OpenBB/website/content/platform/reference/forex/load.md

title, description

title	description
load	OpenBB Platform Function

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

load

Forex Historical Price. Forex historical data.

load(symbol: Union[str, List[str]], start_date: Union[date, str] = None, end_date: Union[date, str] = None, provider: Literal[str] = fmp)

---

Parameters

Name	Type	Description	Default	Optional
symbol	Union[str, List[str]]	Symbol Pair to get data for in CURR1-CURR2 or CURR1CURR2 format.		False
start_date	Union[date, str]	Start date of the data, in YYYY-MM-DD format.	None	True
end_date	Union[date, str]	End date of the data, in YYYY-MM-DD format.	None	True
provider	Literal['fmp', 'polygon']	The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.	fmp	True

Name	Type	Description	Default	Optional
symbol	Union[str, List[str]]	Symbol Pair to get data for in CURR1-CURR2 or CURR1CURR2 format.		False
start_date	Union[date, str]	Start date of the data, in YYYY-MM-DD format.	None	True
end_date	Union[date, str]	End date of the data, in YYYY-MM-DD format.	None	True
provider	Literal['fmp', 'polygon']	The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.	fmp	True
interval	Literal['1min', '5min', '15min', '30min', '1hour', '4hour', '1day']	Data granularity.	1day	True

Name	Type	Description	Default	Optional
symbol	Union[str, List[str]]	Symbol Pair to get data for in CURR1-CURR2 or CURR1CURR2 format.		False
start_date	Union[date, str]	Start date of the data, in YYYY-MM-DD format.	None	True
end_date	Union[date, str]	End date of the data, in YYYY-MM-DD format.	None	True
provider	Literal['fmp', 'polygon']	The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.	fmp	True
multiplier	int	Multiplier of the timespan.	1	True
timespan	Literal['minute', 'hour', 'day', 'week', 'month', 'quarter', 'year']	Timespan of the data.	day	True
sort	Literal['asc', 'desc']	Sort order of the data.	desc	True
limit	int	The number of data entries to return.	49999	True
adjusted	bool	Whether the data is adjusted.	True	True

---

Returns

OBBject
    results : List[ForexHistorical]
        Serializable results.

    provider : Optional[Literal['fmp', 'polygon']]
        Provider name.

    warnings : Optional[List[Warning_]]
        List of warnings.

    chart : Optional[Chart]
        Chart object.

    metadata: Optional[Metadata]
        Metadata info about the command execution.

---

Data

Name	Type	Description
date	datetime	The date of the data.
open	float	The open price of the symbol.
high	float	The high price of the symbol.
low	float	The low price of the symbol.
close	float	The close price of the symbol.
volume	float	The volume of the symbol.
vwap	float	Volume Weighted Average Price of the symbol.

Name	Type	Description
date	datetime	The date of the data.
open	float	The open price of the symbol.
high	float	The high price of the symbol.
low	float	The low price of the symbol.
close	float	The close price of the symbol.
volume	float	The volume of the symbol.
vwap	float	Volume Weighted Average Price of the symbol.
adj_close	float	Adjusted Close Price of the symbol.
unadjusted_volume	float	Unadjusted volume of the symbol.
change	float	Change in the price of the symbol from the previous day.
change_percent	float	Change % in the price of the symbol.
label	str	Human readable format of the date.
change_over_time	float	Change % in the price of the symbol over a period of time.

Name	Type	Description
date	datetime	The date of the data.
open	float	The open price of the symbol.
high	float	The high price of the symbol.
low	float	The low price of the symbol.
close	float	The close price of the symbol.
volume	float	The volume of the symbol.
vwap	float	Volume Weighted Average Price of the symbol.
transactions	int	Number of transactions for the symbol in the time period.