Tmx Futures Instruments
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
TmxFuturesInstruments | TmxFuturesInstrumentsQueryParams | TmxFuturesInstrumentsData |
Import Statement
from openbb_core.provider.standard_models. import (
TmxFuturesInstrumentsData,
TmxFuturesInstrumentsQueryParams,
)
Parameters
- standard
- tmx
asset_class: str | None
Restrict to one Montreal Exchange instrument class.
instrument_type: str | None
Default: future
Restrict to 'future' or 'option'. Defaults to futures only; set to None for the complete listed universe.
use_cache: bool | None
Default: True
Whether to use the on-disk response cache. Set to False to bypass.
Data
- standard
- tmx
symbol: str
The Montreal Exchange root symbol.
name: str | None
Name of the underlying or product, where TMX publishes one.
instrument_type: str | None
Whether the product is an option or a future.
underlying_symbol: str | None
The symbol of the underlying instrument.
expiry_cycle: str | None
The listed expiry cycle, either 'standard' or 'short'.
has_weekly_options: bool | None
Whether weekly expirations are listed.
has_long_term_options: bool | None
Whether long-term equity options are listed.
asset_class: str | None
The instrument class.
asset_class_name: str | None
The instrument class, as published.
quote_symbol: str | None
The symbol that quotes the front contract, where one exists.