info
Profile of an index, with links to its factsheet and methodology.
Examples
from openbb import obb
# Index profile, documents, and key data.
obb.tmx.index.info(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: TmxIndexInfo
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
The name of the index.
description: str | None
The short description of the index.
methodology: str | None
URL to the methodology document.
factsheet: str | None
URL to the factsheet document.
num_constituents: int | None
The number of constituents in the index.
symbol: str
Symbol representing the entity requested in the data.
name: str
The name of the index.
description: str | None
The short description of the index.
methodology: str | None
URL to the methodology document.
factsheet: str | None
URL to the factsheet document.
num_constituents: int | None
The number of constituents in the index.
last_updated: str | None
The timestamp of the last update to the index file.
market_value: float | None
The total quoted market value of the index.
average_constituent_market_value: float | None
The average quoted market value of a constituent.
median_constituent_market_value: float | None
The median quoted market value of a constituent.
top_10_market_value: float | None
The combined quoted market value of the ten largest constituents.
largest_constituent_market_value: float | None
The quoted market value of the largest constituent.
smallest_constituent_market_value: float | None
The quoted market value of the smallest constituent.
largest_constituent_weight: float | None
The weight of the largest constituent.
smallest_constituent_weight: float | None
The weight of the smallest constituent.
previous_day: float | None
The price return over the previous session.
month_to_date: float | None
The month-to-date price return.
quarter_to_date: float | None
The quarter-to-date price return.
year_to_date: float | None
The year-to-date price return.
pe_ratio: float | None
The price-to-earnings ratio of the index.
pb_ratio: float | None
The price-to-book ratio of the index.
price_to_sales: float | None
The price-to-sales ratio of the index.
price_to_cash_flow: float | None
The price-to-cash-flow ratio of the index.
dividend_yield: float | None
The dividend yield of the index.