Tmx Etf Search
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
TmxEtfSearch | TmxEtfSearchQueryParams | TmxEtfSearchData |
Import Statement
from openbb_core.provider.standard_models. import (
TmxEtfSearchData,
TmxEtfSearchQueryParams,
)
Parameters
- standard
- tmx
query: str | None
Search query.
query: str | None
Search query.
div_freq: str | None
The dividend payment frequency.
asset_class: str | None
Filter by asset class.
region: str | None
Filter by region.
fund_family: str | None
Filter by fund family.
investment_style: str | None
Filter by investment style.
currency: str | None
Filter by the currency the fund trades in.
esg: bool | None
Restrict to funds flagged as ESG.
sort_by: str | None
The column to sort by.
use_cache: bool | None
Default: True
Whether to use a cached request. All ETF data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 4 hours.
Data
- standard
- tmx
symbol: str
Symbol representing the entity requested in the data.(ETF)
name: str | None
Name of the ETF.
symbol: str
Symbol representing the entity requested in the data.(ETF)
name: str | None
Name of the ETF.
short_name: str | None
The short name of the ETF.
inception_date: str | None
The inception date of the ETF.
issuer: str | None
The issuer of the ETF.
investment_style: str | None
The investment style of the ETF.
esg: bool | None
Whether the ETF qualifies as an ESG fund.
currency: str
The currency of the ETF.
unit_price: float | None
The unit price of the ETF.
close: float
The closing price of the ETF.
prev_close: float | None
The previous closing price of the ETF.
return_1m: float | None
The one-month return of the ETF, as a normalized percent.
return_3m: float | None
The three-month return of the ETF, as a normalized percent.
return_6m: float | None
The six-month return of the ETF, as a normalized percent.
return_ytd: float | None
The year-to-date return of the ETF, as a normalized percent.
return_1y: float | None
The one-year return of the ETF, as a normalized percent.
beta_1y: float | None
The one-year beta of the ETF, as a normalized percent.
return_3y: float | None
The three-year return of the ETF, as a normalized percent.
beta_3y: float | None
The three-year beta of the ETF, as a normalized percent.
return_5y: float | None
The five-year return of the ETF, as a normalized percent.
beta_5y: float | None
The five-year beta of the ETF, as a normalized percent.
return_10y: float | None
The ten-year return of the ETF, as a normalized percent.
beta_10y: float | None
The ten-year beta of the ETF.
beta_15y: float | None
The fifteen-year beta of the ETF.
return_from_inception: float | None
The return from inception of the ETF, as a normalized percent.
avg_volume: int | None
The average daily volume of the ETF.
avg_volume_30d: int | None
The 30-day average volume of the ETF.
aum: float | None
The AUM of the ETF.
pe_ratio: float | None
The price-to-earnings ratio of the ETF.
pb_ratio: float | None
The price-to-book ratio of the ETF.
management_fee: float | None
The management fee of the ETF, as a normalized percent.
mer: float | None
The management expense ratio of the ETF, as a normalized percent.
distribution_yield: float | None
The distribution yield of the ETF, as a normalized percent.
dividend_frequency: str | None
The dividend payment frequency of the ETF.