constituents
Constituents of an index, with weights and key data.
Examples
from openbb import obb
# Index constituents and weights.
obb.tmx.index.constituents(symbol='^TSX', provider='tmx')
Parameters
- standard
- tmx
symbol: str
Symbol to get data for.
symbol: str
Symbol to get data for.
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: TmxIndexConstituents
Serializable results.
provider: str | None
Provider name.
warnings: Optional[list[Warning_]]
List of warnings.
chart: Optional[Chart]
Chart object.
extra: dict[str, Any]
Extra info.
Data
- standard
- tmx
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.
exchange: str | None
The exchange the constituent is listed on.
market_value: float | None
The quoted market value of the asset.
weight: float | None
The weight of the constituent in the index.