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 | None
Search query.
query: str | None
Search query.
exchange: Literal['amex', 'nyse', 'nasdaq', 'tsx', 'euronext'] | None
Exchange where the ETF is listed. If not provided, all exchanges are searched.
country: Country | None
Filter by country. Accepts ISO 3166-1 alpha-2 codes (e.g., 'US', 'DE'), alpha-3 codes (e.g., 'USA'), or country names (e.g., 'United States', 'united_states').
query: str | None
Search query.
exchange: Literal['xnas', 'arcx', 'bats', 'xnys', 'bvmf', 'xshg', 'xshe', 'xhkg', 'xbom', 'xnse', 'xidx', 'tase', 'xkrx', 'xkls', 'xmex', 'xses', 'roco', 'xtai', 'xbkk', 'xist'] | None
Target a specific exchange by providing the MIC code.
query: str | None
Search query.
div_freq: Literal['monthly', 'annually', 'quarterly'] | None
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'] | 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
- fmp
- intrinio
- 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.
country: str | None
Country where the ETF is domiciled.
exchange: str | None
Exchange where the ETF is listed.
exchange_name: str | None
The full name of the exchange.
market_cap: int | float | None
Market capitalization of the ETF.
beta: float | None
Beta of the ETF.
price: float | None
Current price of the ETF.
last_annual_dividend: float | None
Last annual dividend paid.
volume: int | float | None
Current trading volume of the ETF.
symbol: str
Symbol representing the entity requested in the data.(ETF)
name: str | None
Name of the ETF.
exchange: str | None
The exchange MIC code.
figi_ticker: str | None
The OpenFIGI ticker.
ric: str | None
The Reuters Instrument Code.
isin: str | None
The International Securities Identification Number.
sedol: str | None
The Stock Exchange Daily Official list.
intrinio_id: str | None
The unique Intrinio ID for the security.
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 | None
The currency of the ETF.
unit_price: float | None
The unit price of the ETF.
close: float | None
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.