Tmx Rankings
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
TmxRankings | TmxRankingsQueryParams | TmxRankingsData |
Import Statement
from openbb_core.provider.standard_models. import (
TmxRankingsData,
TmxRankingsQueryParams,
)
Parameters
- standard
- tmx
ranking: str | None
Default: tsx30
The published ranking. 'tsx30' is the Toronto Stock Exchange's top thirty performers, 'venture50' the TSX Venture Exchange's top fifty.
use_cache: bool | None
Default: True
Whether to use a cached request. The rankings are published annually and cached for one day. To bypass, set to False.
Data
- standard
- tmx
rank: int | None
The position in the ranking.
symbol: str | None
The ticker symbol.
name: str | None
The name of the company.
sector: str | None
The sector of the company.
industry: str | None
The industry of the company.
location: str | None
The province the company is headquartered in.
share_price_appreciation: float | None
The share price appreciation over the ranking period.
market_cap_change: float | None
The change in market capitalization over the ranking period.
description: str | None
A description of the company.
website: str | None
The company's website.
logo_url: str | None
The company's logo.