constituents

Get Index Constituents.

Examples

from openbb import obb
obb.index.constituents(symbol='dowjones', provider='fmp')
# Providers other than FMP will use the ticker symbol.
obb.index.constituents(symbol='BEP50P', provider='cboe')

---

Parameters

• standard
• cboe
• fmp
• tmx

Name	Type	Description	Default	Optional
symbol	str	Symbol to get data for.		False

Name	Type	Description	Default	Optional
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	BUK100P	True

Name	Type	Description	Default	Optional
symbol	Literal['dowjones', 'sp500', 'nasdaq']	None	dowjones	True

Name	Type	Description	Default	Optional
symbol	str	Symbol to get data for.		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.	True	True

---

Returns

OBBject
    results : List[IndexConstituents]
        Serializable results.

    provider : Optional[Literal['cboe', 'fmp', 'tmx']]
        Provider name.

    warnings : Optional[List[Warning_]]
        List of warnings.

    chart : Optional[Chart]
        Chart object.

    extra : Dict[str, Any]
        Extra info.

---

Data

• standard
• cboe
• fmp
• tmx

Name	Type	Description
symbol	str	Symbol representing the entity requested in the data.
name	str	Name of the constituent company in the index.

Name	Type	Description
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.

Name	Type	Description
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.

Name	Type	Description
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.