snapshots
Index Snapshots. Current levels for all indices from a provider, grouped by region.
Parameters
- standard
- cboe
- tmx
region: str | None
Default: us
The region of focus for the data - i.e., us, eu.
region: Literal['us', 'eu'] | None
Default: us
None
region: Literal['ca', 'us'] | None
Default: ca
None
use_cache: bool | None
Default: True
Whether to use a cached request. Index data is from a single JSON file, updated each day after close. It is cached for one day. To bypass, set to False.
Returns
results: IndexSnapshots
Serializable results.
provider: Optional[Literal['cboe', 'tmx']]
Provider name.
warnings: Optional[list[Warning_]]
list of warnings.
chart: Optional[Chart]
Chart object.
extra: dict[str, Any]
Extra info.
Data
- standard
- cboe
- tmx
symbol: str
Symbol representing the entity requested in the data.
name: str | None
Name of the index.
currency: str | None
Currency of the index.
price: float | None
Current price of the index.
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: int | None
The trading volume.
prev_close: float | None
The previous close price.
change: float | None
Change in value of the index.
change_percent: float | None
Change, in normalized percentage points, of the index.
symbol: str
Symbol representing the entity requested in the data.
name: str | None
Name of the index.
currency: str | None
Currency of the index.
price: float | None
Current price of the index.
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: int | None
The trading volume.
prev_close: float | None
The previous close price.
change: float | None
Change in price.
change_percent: float | None
Change in price as a normalized percentage.
bid: float | None
Current bid price.
ask: float | None
Current ask price.
last_trade_time: datetime | None
Last trade timestamp for the symbol.
status: str | None
Status of the market, open or closed.
symbol: str
Symbol representing the entity requested in the data.
name: str | None
Name of the index.
currency: str | None
Currency of the index.
price: float | None
Current price of the index.
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: int | None
The trading volume.
prev_close: float | None
The previous close price.
change: float | None
Change in value of the index.
change_percent: float | None
Change, in normalized percentage points, of the index.
year_high: float | None
The 52-week high of the index.
year_low: float | None
The 52-week low of the index.
return_mtd: float | None
The month-to-date return of the index, as a normalized percent.
return_qtd: float | None
The quarter-to-date return of the index, as a normalized percent.
return_ytd: float | None
The year-to-date return of the index, as a normalized percent.
total_market_value: float | None
The total quoted market value of the index.
number_of_constituents: int | None
The number of constituents in the index.
constituent_average_market_value: float | None
The average quoted market value of the index constituents.
constituent_median_market_value: float | None
The median quoted market value of the index constituents.
constituent_top10_market_value: float | None
The sum of the top 10 quoted market values of the index constituents.
constituent_largest_market_value: float | None
The largest quoted market value of the index constituents.
constituent_largest_weight: float | None
The largest weight of the index constituents, as a normalized percent.
constituent_smallest_market_value: float | None
The smallest quoted market value of the index constituents.
constituent_smallest_weight: float | None
The smallest weight of the index constituents, as a normalized percent.