Etf Search

---

Implementation details

Class names

Model name	Parameters class	Data class
EtfSearch	EtfSearchQueryParams	EtfSearchData

Import Statement

from openbb_core.provider.standard_models.etf_search import (
EtfSearchData,
EtfSearchQueryParams,
)

Parameters

• standard
• fmp
• intrinio
• tmx

query: str
Search query.

query: str
Search query.

exchange: Literal['amex', 'nyse', 'nasdaq', 'tsx', 'euronext']
Exchange where the ETF is listed. If not provided, all exchanges are searched.

query: str
Search query.

exchange: Literal['xnas', 'arcx', 'bats', 'xnys', 'bvmf', 'xshg', 'xshe', 'xhkg', 'xbom', 'xnse', 'xidx', 'tase', 'xkrx', 'xkls', 'xmex', 'xses', 'roco', 'xtai', 'xbkk', 'xist']
Target a specific exchange by providing the MIC code.

query: str
Search query.

div_freq: Literal['monthly', 'annually', 'quarterly']
The dividend payment frequency.

sort_by: Literal['aum', 'return_1m', 'return_3m', 'return_6m', 'return_1y', 'return_3y', 'return_ytd', 'beta_1y', 'volume_avg_daily', 'management_fee', 'distribution_yield', 'pb_ratio', 'pe_ratio']
The column to sort by.

use_cache: bool
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
• fmp
• intrinio
• tmx

symbol: str
Symbol representing the entity requested in the data.(ETF)

name: str
Name of the ETF.

symbol: str
Symbol representing the entity requested in the data.(ETF)

name: str
Name of the ETF.

country: str
Country where the ETF is domiciled.

exchange: str
Exchange where the ETF is listed.

exchange_name: str
The full name of the exchange.

market_cap: Union[float, int]
Market capitalization of the ETF.

beta: float
Beta of the ETF.

price: float
Current price of the ETF.

last_annual_dividend: float
Last annual dividend paid.

volume: Union[float, int]
Current trading volume of the ETF.

symbol: str
Symbol representing the entity requested in the data.(ETF)

name: str
Name of the ETF.

exchange: str
The exchange MIC code.

figi_ticker: str
The OpenFIGI ticker.

ric: str
The Reuters Instrument Code.

isin: str
The International Securities Identification Number.

sedol: str
The Stock Exchange Daily Official list.

intrinio_id: str
The unique Intrinio ID for the security.

symbol: str
Symbol representing the entity requested in the data.(ETF)

name: str
Name of the ETF.

short_name: str
The short name of the ETF.

inception_date: str
The inception date of the ETF.

issuer: str
The issuer of the ETF.

investment_style: str
The investment style of the ETF.

esg: bool
Whether the ETF qualifies as an ESG fund.

currency: str
The currency of the ETF.

unit_price: float
The unit price of the ETF.

close: float
The closing price of the ETF.

prev_close: float
The previous closing price of the ETF.

return_1m: float
The one-month return of the ETF, as a normalized percent.

return_3m: float
The three-month return of the ETF, as a normalized percent.

return_6m: float
The six-month return of the ETF, as a normalized percent.

return_ytd: float
The year-to-date return of the ETF, as a normalized percent.

return_1y: float
The one-year return of the ETF, as a normalized percent.

beta_1y: float
The one-year beta of the ETF, as a normalized percent.

return_3y: float
The three-year return of the ETF, as a normalized percent.

beta_3y: float
The three-year beta of the ETF, as a normalized percent.

return_5y: float
The five-year return of the ETF, as a normalized percent.

beta_5y: float
The five-year beta of the ETF, as a normalized percent.

return_10y: float
The ten-year return of the ETF, as a normalized percent.

beta_10y: float
The ten-year beta of the ETF.

beta_15y: float
The fifteen-year beta of the ETF.

return_from_inception: float
The return from inception of the ETF, as a normalized percent.

avg_volume: int
The average daily volume of the ETF.

avg_volume_30d: int
The 30-day average volume of the ETF.

aum: float
The AUM of the ETF.

pe_ratio: float
The price-to-earnings ratio of the ETF.

pb_ratio: float
The price-to-book ratio of the ETF.

management_fee: float
The management fee of the ETF, as a normalized percent.

mer: float
The management expense ratio of the ETF, as a normalized percent.

distribution_yield: float
The distribution yield of the ETF, as a normalized percent.

dividend_frequency: str
The dividend payment frequency of the ETF.