Tmx Index Historical
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
TmxIndexHistorical | TmxIndexHistoricalQueryParams | TmxIndexHistoricalData |
Import Statement
from openbb_core.provider.standard_models. import (
TmxIndexHistoricalData,
TmxIndexHistoricalQueryParams,
)
Parameters
- standard
- tmx
symbol: str
Symbol to get data for.
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.
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.
use_cache: bool | None
Default: True
Whether to use a cached request. The daily levels are cached for six hours. To bypass, set to False.
Data
- standard
- tmx
symbol: str | None
Symbol representing the entity requested in the data.
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 | None
The close price.
volume: float | int | None
The trading volume.
symbol: str | None
Symbol representing the entity requested in the data.
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 | None
The close price.
volume: float | int | None
The trading volume.
change: float | None
The change in the level from the previous session.
change_percent: float | None
The change in the level from the previous session, as a percent.
vwap: float | None
The volume weighted average price of the session.
trade_value: float | None
The total value traded over the session.
transactions: int | None
The number of transactions over the session.