historical
Historical rates for a currency pair.
Examples
from openbb import obb
# Currency pair history.
obb.tmx.currency.historical(symbol='USDCAD', provider='tmx')
Parameters
- standard
- tmx
symbol: str
Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format.
start_date: date | None | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | None | str
End date of the data, in YYYY-MM-DD format.
symbol: str
Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format.
start_date: date | None | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | None | str
End date of the data, in YYYY-MM-DD format.
interval: str | None
Default: day
The interval of the bars.
Returns
results: TmxCurrencyHistorical
Serializable results.
provider: str | None
Provider name.
warnings: Optional[list[Warning_]]
List of warnings.
chart: Optional[Chart]
Chart object.
extra: dict[str, Any]
Extra info.
Data
- standard
- tmx
date: date | datetime | str
The date of the data.
open: float | None
The open price.
high: float | None
The high price.
low: float | None
The low price.
close: float
The close price.
volume: float | None
The trading volume.
vwap: float | None
Volume Weighted Average Price over the period.
date: date | datetime | str
The date of the data.
open: float | None
The open price.
high: float | None
The high price.
low: float | None
The low price.
close: float
The close price.
volume: float | None
The trading volume.
vwap: float | None
Volume Weighted Average Price over the period.