Index Constituents
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
IndexConstituents | IndexConstituentsQueryParams | IndexConstituentsData |
Import Statement
from openbb_core.provider.standard_models.index_constituents import (
IndexConstituentsData,
IndexConstituentsQueryParams,
)
Parameters
- standard
- cboe
- fmp
- tmx
symbol: str
Symbol to get data for.
• Optional: False
symbol: Literal['BAT20P', 'BBE20P', 'BCH20P', 'BCHM30P', 'BDE40P', 'BDEM50P', 'BDES50P', 'BDK25P', 'BEP50P', 'BEPACP', 'BEPBUS', 'BEPCNC', 'BEPCONC', 'BEPCONS', 'BEPENGY', 'BEPFIN', 'BEPHLTH', 'BEPIND', 'BEPNEM', 'BEPTEC', 'BEPTEL', 'BEPUTL', 'BEPXUKP', 'BES35P', 'BEZ50P', 'BEZACP', 'BFI25P', 'BFR40P', 'BFRM20P', 'BIE20P', 'BIT40P', 'BNL25P', 'BNLM25P', 'BNO25G', 'BNORD40P', 'BPT20P', 'BSE30P', 'BUK100P', 'BUK250P', 'BUK350P', 'BUKAC', 'BUKBISP', 'BUKBUS', 'BUKCNC', 'BUKCONC', 'BUKCONS', 'BUKENGY', 'BUKFIN', 'BUKHI50P', 'BUKHLTH', 'BUKIND', 'BUKLO50P', 'BUKMINP', 'BUKNEM', 'BUKSC', 'BUKTEC', 'BUKTEL', 'BUKUTL']
None
• Default: BUK100P
• Optional: True
symbol: Literal['dowjones', 'sp500', 'nasdaq']
None
• Default: dowjones
• Optional: True
symbol: str
Symbol to get data for.
• Optional: False
use_cache: bool
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.
• Default: True
• Optional: True
Data
- standard
- cboe
- fmp
- tmx
symbol: str
Symbol representing the entity requested in the data.
name: str
Name of the constituent company in the index.
symbol: str
Symbol representing the entity requested in the data.
name: str
Name of the constituent company in the index.
security_type: str
The type of security represented.
last_price: float
Last price for the symbol.
open: float
The open price.
high: float
The high price.
low: float
The low price.
close: float
The close price.
volume: int
The trading volume.
prev_close: float
The previous close price.
change: float
Change in price.
change_percent: float
Change in price as a normalized percentage.
tick: str
Whether the last sale was an up or down tick.
last_trade_time: datetime
Last trade timestamp for the symbol.
asset_type: str
Type of asset.
symbol: str
Symbol representing the entity requested in the data.
name: str
Name of the constituent company in the index.
sector: str
Sector the constituent company in the index belongs to.
sub_sector: str
Sub-sector the constituent company in the index belongs to.
headquarter: str
Location of the headquarter of the constituent company in the index.
date_first_added: Union[date, str]
Date the constituent company was added to the index.
cik: int
Central Index Key (CIK) for the requested entity.
founded: Union[date, str]
Founding year of the constituent company in the index.
symbol: str
Symbol representing the entity requested in the data.
name: str
Name of the constituent company in the index.
market_value: float
The quoted market value of the asset.