Cboe Index Constituents
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
CboeIndexConstituents | CboeIndexConstituentsQueryParams | CboeIndexConstituentsData |
Import Statement
from openbb_core.provider.standard_models. import (
CboeIndexConstituentsData,
CboeIndexConstituentsQueryParams,
)
Parameters
- standard
- cboe
symbol: str
Symbol to get data for.
symbol: str | None
Default: BUK100P
Symbol to get data for. European indices return current-day constituent quotes; Cboe Australia (CXA) indices return the index composition with weights.
session: str | None
Default: eod
Only valid for Cboe Australia (CXA) indices. 'eod' is the last close, 'sod' is the projected next-session open.
Choices
- eod
- sod
Data
- standard
- cboe
symbol: str
Symbol representing the entity requested in the data.
name: str | None
Name of the constituent company in the index.
symbol: str
Symbol representing the entity requested in the data.
name: str | None
Name of the constituent company in the index.
security_type: str | None
The type of security represented.
weight: float | None
Weight of the constituent in the index, as a normalized percentage. Only valid for Cboe Australia (CXA) indices.
last_price: float | None
Last price for the symbol.
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.
tick: str | None
Whether the last sale was an up or down tick.
last_trade_time: datetime | None
Last trade timestamp for the symbol.
asset_type: str | None
Type of asset.
market: str | None
Market the constituent trades on.
region: str | None
Domicile of the constituent.
currency: str | None
Currency the constituent is priced in.
isin: str | None
ISIN of the constituent.
sedol: str | None
SEDOL of the constituent.
gics: str | None
GICS sub-industry code of the constituent.
security_state: str | None
Trading state of the constituent at capture.
shares_outstanding: float | None
Shares in issue used for the index calculation.
float_ratio: float | None
Free-float ratio applied to the market cap.
adjustment_factor: float | None
Index adjustment factor applied to the market cap.
exchange_rate: float | None
Rate used to convert into the index currency.
market_cap: float | None
Total market capitalization of the constituent.
adjusted_market_cap: float | None
Free-float adjusted market capitalization used for the weight.