Etf Info

---

Implementation details

Class names

Model name	Parameters class	Data class
EtfInfo	EtfInfoQueryParams	EtfInfoData

Import Statement

from openbb_core.provider.standard_models.etf_info import (
EtfInfoData,
EtfInfoQueryParams,
)

Parameters

• standard
• fmp
• intrinio
• tmx
• yfinance

symbol: str | list[str]
Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp, intrinio, tmx, yfinance.

symbol: str | list[str]
Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp, intrinio, tmx, yfinance.

symbol: str | list[str]
Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp, intrinio, tmx, yfinance.

symbol: str | list[str]
Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp, intrinio, tmx, yfinance.

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.

symbol: str | list[str]
Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp, intrinio, tmx, yfinance.

Data

• standard
• fmp
• intrinio
• tmx
• yfinance

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

name: str | None
Name of the ETF.

issuer: str | None
Issuer of the ETF.

domicile: str | None
Domicile of the ETF.

website: str | None
Website of the ETF.

description: str | None
Description of the fund.

inception_date: date | None
Inception date of the ETF.

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

name: str | None
Name of the ETF.

issuer: str | None
Issuer of the ETF.

domicile: str | None
Domicile of the ETF.

website: str | None
Website of the ETF.

description: str | None
Description of the fund.

inception_date: date | None
Inception date of the ETF.

cusip: str | None
CUSIP of the ETF.

isin: str | None
ISIN of the ETF.

asset_class: str | None
Asset class of the ETF.

currency: str | None
Currency of the ETF's net asset value.

holdings_count: int | None
Number of holdings.

aum: float | None
Assets under management.

expense_ratio: float | None
The expense ratio, as a normalized percent.

nav: float | None
Net asset value of the ETF.

volume_avg: int | float | None
Average daily trading volume.

updated: datetime | None
As of date for the latest data point.

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

name: str | None
Name of the ETF.

issuer: str | None
Issuer of the ETF.

domicile: str | None
2 letter ISO country code for the country where the ETP is domiciled.

website: str | None
Website of the ETF.

description: str | None
Description of the fund.

inception_date: date | None
Inception date of the ETF.

fund_listing_date: date | None
The date on which the Exchange Traded Product (ETP) or share class of the ETP is listed on a specific exchange.

data_change_date: date | None
The last date on which there was a change in a classifications data field for this ETF.

etn_maturity_date: date | None
If the product is an ETN, this field identifies the maturity date for the ETN.

is_listed: bool | None
If true, the ETF is still listed on an exchange.

close_date: date | None
The date on which the ETF was de-listed if it is no longer listed.

exchange: str | None
The exchange Market Identifier Code (MIC).

isin: str | None
International Securities Identification Number (ISIN).

ric: str | None
Reuters Instrument Code (RIC).

sedol: str | None
Stock Exchange Daily Official list (SEDOL).

figi_symbol: str | None
Financial Instrument Global Identifier (FIGI) symbol.

share_class_figi: str | None
Financial Instrument Global Identifier (FIGI).

firstbridge_id: str | None
The FirstBridge unique identifier for the Exchange Traded Fund (ETF).

firstbridge_parent_id: str | None
The FirstBridge unique identifier for the parent Exchange Traded Fund (ETF), if applicable.

intrinio_id: str | None
Intrinio unique identifier for the security.

intraday_nav_symbol: str | None
Intraday Net Asset Value (NAV) symbol.

primary_symbol: str | None
The primary ticker field is used for Exchange Traded Products (ETPs) that have multiple listings and share classes. If an ETP has multiple listings or share classes, the same primary ticker is assigned to all the listings and share classes.

etp_structure_type: str | None
Classifies Exchange Traded Products (ETPs) into very broad categories based on its legal structure.

legal_structure: str | None
Legal structure of the fund.

etn_issuing_bank: str | None
If the product is an Exchange Traded Note (ETN), this field identifies the issuing bank.

fund_family: str | None
This field identifies the fund family to which the ETF belongs, as categorized by the ETF Sponsor.

investment_style: str | None
Investment style of the ETF.

derivatives_based: str | None
This field is populated if the ETF holds either listed or over-the-counter derivatives in its portfolio.

income_category: str | None
Identifies if an Exchange Traded Fund (ETF) falls into a category that is specifically designed to provide a high yield or income

asset_class: str | None
Captures the underlying nature of the securities in the Exchanged Traded Product (ETP).

other_asset_types: str | None
If 'asset_class' field is classified as 'Other Asset Types' this field captures the specific category of the underlying assets.

single_category_designation: str | None
This categorization is created for those users who want every ETF to be 'forced' into a single bucket, so that the assets for all categories will always sum to the total market.

beta_type: str | None
This field identifies whether an ETF provides 'Traditional' beta exposure or 'Smart' beta exposure. ETFs that are active (i.e. non-indexed), leveraged / inverse or have a proprietary quant model (i.e. that don't provide indexed exposure to a targeted factor) are classified separately.

beta_details: str | None
This field provides further detail within the traditional and smart beta categories.

market_cap_range: str | None
Equity ETFs are classified as falling into categories based on the description of their investment strategy in the prospectus. Examples ('Mega Cap', 'Large Cap', 'Mid Cap', etc.)

market_cap_weighting_type: str | None
For ETFs that take the value 'Market Cap Weighted' in the 'index_weighting_scheme' field, this field provides detail on the market cap weighting type.

index_weighting_scheme: str | None
For ETFs that track an underlying index, this field provides detail on the index weighting type.

index_linked: str | None
This field identifies whether an ETF is index linked or active.

index_name: str | None
This field identifies the name of the underlying index tracked by the ETF, if applicable.

index_symbol: str | None
This field identifies the OpenFIGI ticker for the Index underlying the ETF.

parent_index: str | None
This field identifies the name of the parent index, which represents the broader universe from which the index underlying the ETF is created, if applicable.

index_family: str | None
This field identifies the index family to which the index underlying the ETF belongs. The index family is represented as categorized by the index provider.

broader_index_family: str | None
This field identifies the broader index family to which the index underlying the ETF belongs. The broader index family is represented as categorized by the index provider.

index_provider: str | None
This field identifies the Index provider for the index underlying the ETF, if applicable.

index_provider_code: str | None
This field provides the First Bridge code for each Index provider, corresponding to the index underlying the ETF if applicable.

replication_structure: str | None
The replication structure of the Exchange Traded Product (ETP).

growth_value_tilt: str | None
Classifies equity ETFs as either 'Growth' or Value' based on the stated style tilt in the ETF prospectus. Equity ETFs that do not have a stated style tilt are classified as 'Core / Blend'.

growth_type: str | None
For ETFs that are classified as 'Growth' in 'growth_value_tilt', this field further identifies those where the stocks in the ETF are both selected and weighted based on their growth (style factor) scores.

value_type: str | None
For ETFs that are classified as 'Value' in 'growth_value_tilt', this field further identifies those where the stocks in the ETF are both selected and weighted based on their value (style factor) scores.

sector: str | None
For equity ETFs that aim to provide targeted exposure to a sector or industry, this field identifies the Sector that it provides the exposure to.

industry: str | None
For equity ETFs that aim to provide targeted exposure to an industry, this field identifies the Industry that it provides the exposure to.

industry_group: str | None
For equity ETFs that aim to provide targeted exposure to a sub-industry, this field identifies the sub-Industry that it provides the exposure to.

cross_sector_theme: str | None
For equity ETFs that aim to provide targeted exposure to a specific investment theme that cuts across GICS sectors, this field identifies the specific cross-sector theme. Examples ('Agri-business', 'Natural Resources', 'Green Investing', etc.)

natural_resources_type: str | None
For ETFs that are classified as 'Natural Resources' in the 'cross_sector_theme' field, this field provides further detail on the type of Natural Resources exposure.

us_or_excludes_us: str | None
Takes the value of 'Domestic' for US exposure, 'International' for non-US exposure and 'Global' for exposure that includes all regions including the US.

developed_emerging: str | None
This field identifies the stage of development of the markets that the ETF provides exposure to.

specialized_region: str | None
This field is populated if the ETF provides targeted exposure to a specific type of geography-based grouping that does not fall into a specific country or continent grouping. Examples ('BRIC', 'Chindia', etc.)

continent: str | None
This field is populated if the ETF provides targeted exposure to a specific continent or country within that Continent.

latin_america_sub_group: str | None
For ETFs that are classified as 'Latin America' in the 'continent' field, this field provides further detail on the type of regional exposure.

europe_sub_group: str | None
For ETFs that are classified as 'Europe' in the 'continent' field, this field provides further detail on the type of regional exposure.

asia_sub_group: str | None
For ETFs that are classified as 'Asia' in the 'continent' field, this field provides further detail on the type of regional exposure.

specific_country: str | None
This field is populated if the ETF provides targeted exposure to a specific country.

china_listing_location: str | None
For ETFs that are classified as 'China' in the 'country' field, this field provides further detail on the type of exposure in the underlying securities.

us_state: str | None
Takes the value of a US state if the ETF provides targeted exposure to the municipal bonds or equities of companies.

real_estate: str | None
For ETFs that provide targeted real estate exposure, this field is populated if the ETF provides targeted exposure to a specific segment of the real estate market.

fundamental_weighting_type: str | None
For ETFs that take the value 'Fundamental Weighted' in the 'index_weighting_scheme' field, this field provides detail on the fundamental weighting methodology.

dividend_weighting_type: str | None
For ETFs that take the value 'Dividend Weighted' in the 'index_weighting_scheme' field, this field provides detail on the dividend weighting methodology.

bond_type: str | None
For ETFs where 'asset_class_type' is 'Bonds', this field provides detail on the type of bonds held in the ETF.

government_bond_types: str | None
For bond ETFs that take the value 'Treasury & Government' in 'bond_type', this field provides detail on the exposure.

municipal_bond_region: str | None
For bond ETFs that take the value 'Municipal' in 'bond_type', this field provides additional detail on the geographic exposure.

municipal_vrdo: bool | None
For bond ETFs that take the value 'Municipal' in 'bond_type', this field identifies those ETFs that specifically provide exposure to Variable Rate Demand Obligations.

mortgage_bond_types: str | None
For bond ETFs that take the value 'Mortgage' in 'bond_type', this field provides additional detail on the type of underlying securities.

bond_tax_status: str | None
For all US bond ETFs, this field provides additional detail on the tax treatment of the underlying securities.

credit_quality: str | None
For all bond ETFs, this field helps to identify if the ETF provides targeted exposure to securities of a specific credit quality range.

average_maturity: str | None
For all bond ETFs, this field helps to identify if the ETF provides targeted exposure to securities of a specific maturity range.

specific_maturity_year: int | None
For all bond ETFs that take the value 'Specific Maturity Year' in the 'average_maturity' field, this field specifies the calendar year.

commodity_types: str | None
For ETFs where 'asset_class_type' is 'Commodities', this field provides detail on the type of commodities held in the ETF.

energy_type: str | None
For ETFs where 'commodity_type' is 'Energy', this field provides detail on the type of energy exposure provided by the ETF.

agricultural_type: str | None
For ETFs where 'commodity_type' is 'Agricultural', this field provides detail on the type of agricultural exposure provided by the ETF.

livestock_type: str | None
For ETFs where 'commodity_type' is 'Livestock', this field provides detail on the type of livestock exposure provided by the ETF.

metal_type: str | None
For ETFs where 'commodity_type' is 'Gold & Metals', this field provides detail on the type of exposure provided by the ETF.

inverse_leveraged: str | None
This field is populated if the ETF provides inverse or leveraged exposure.

target_date_multi_asset_type: str | None
For ETFs where 'asset_class_type' is 'Target Date / MultiAsset', this field provides detail on the type of commodities held in the ETF.

currency_pair: str | None
This field is populated if the ETF's strategy involves providing exposure to the movements of a currency or involves hedging currency exposure.

social_environmental_type: str | None
This field is populated if the ETF's strategy involves providing exposure to a specific social or environmental theme.

clean_energy_type: str | None
This field is populated if the ETF has a value of 'Clean Energy' in the 'social_environmental_type' field.

dividend_type: str | None
This field is populated if the ETF has an intended investment objective of holding dividend-oriented stocks as stated in the prospectus.

regular_dividend_payor_type: str | None
This field is populated if the ETF has a value of'Dividend - Regular Payors' in the 'dividend_type' field.

quant_strategies_type: str | None
This field is populated if the ETF has either an index-linked or active strategy that is based on a proprietary quantitative strategy.

other_quant_models: str | None
For ETFs where 'quant_strategies_type' is 'Other Quant Model', this field provides the name of the specific proprietary quant model used as the underlying strategy for the ETF.

hedge_fund_type: str | None
For ETFs where 'other_asset_types' is 'Hedge Fund Replication', this field provides detail on the type of hedge fund replication strategy.

excludes_financials: bool | None
For equity ETFs, identifies those ETFs where the underlying fund holdings will not hold financials stocks, based on the funds intended objective.

excludes_technology: bool | None
For equity ETFs, identifies those ETFs where the underlying fund holdings will not hold technology stocks, based on the funds intended objective.

holds_only_nyse_stocks: bool | None
If true, the ETF is an equity ETF and holds only stocks listed on NYSE.

holds_only_nasdaq_stocks: bool | None
If true, the ETF is an equity ETF and holds only stocks listed on Nasdaq.

holds_mlp: bool | None
If true, the ETF's investment objective explicitly specifies that it holds MLPs as an intended part of its investment strategy.

holds_preferred_stock: bool | None
If true, the ETF's investment objective explicitly specifies that it holds preferred stock as an intended part of its investment strategy.

holds_closed_end_funds: bool | None
If true, the ETF's investment objective explicitly specifies that it holds closed end funds as an intended part of its investment strategy.

holds_adr: bool | None
If true, he ETF's investment objective explicitly specifies that it holds American Depositary Receipts (ADRs) as an intended part of its investment strategy.

laddered: bool | None
For bond ETFs, this field identifies those ETFs that specifically hold bonds in a laddered structure, where the bonds are scheduled to mature in an annual, sequential structure.

zero_coupon: bool | None
For bond ETFs, this field identifies those ETFs that specifically hold zero coupon Treasury Bills.

floating_rate: bool | None
For bond ETFs, this field identifies those ETFs that specifically hold floating rate bonds.

build_america_bonds: bool | None
For municipal bond ETFs, this field identifies those ETFs that specifically hold Build America Bonds.

dynamic_futures_roll: bool | None
If the product holds futures contracts, this field identifies those products where the roll strategy is dynamic (rather than entirely rules based), so as to minimize roll costs.

currency_hedged: bool | None
This field is populated if the ETF's strategy involves hedging currency exposure.

includes_short_exposure: bool | None
This field is populated if the ETF has short exposure in any of its holdings e.g. in a long/short or inverse ETF.

ucits: bool | None
If true, the Exchange Traded Product (ETP) is Undertakings for the Collective Investment in Transferable Securities (UCITS) compliant

registered_countries: str | None
The list of countries where the ETF is legally registered for sale. This may differ from where the ETF is domiciled or traded, particularly in Europe.

issuer_country: str | None
2 letter ISO country code for the country where the issuer is located.

listing_country: str | None
2 letter ISO country code for the country of the primary listing.

listing_region: str | None
Geographic region in the country of the primary listing falls.

bond_currency_denomination: str | None
For all bond ETFs, this field provides additional detail on the currency denomination of the underlying securities.

base_currency: str | None
Base currency in which NAV is reported.

listing_currency: str | None
listing currency of the Exchange Traded Product (ETP) in which it is traded. Reported using the 3-digit ISO currency code.

number_of_holdings: int | None
The number of holdings in the ETF.

month_end_assets: float | None
Net assets in millions of dollars as of the most recent month end.

net_expense_ratio: float | None
Gross expense net of Fee Waivers, as a percentage of net assets as published by the ETF issuer.

etf_portfolio_turnover: float | None
The percentage of positions turned over in the last 12 months.

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

name: str | None
Name of the ETF.

issuer: str | None
The issuer of the ETF.

domicile: str | None
Domicile of the ETF.

website: str | None
The website of the ETF.

description: str | None
The description of the ETF.

inception_date: date | None
Inception date 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.

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

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

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

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.

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

name: str | None
Name of the ETF.

issuer: str | None
Issuer of the ETF.

domicile: str | None
Domicile of the ETF.

website: str | None
Website of the ETF.

description: str | None
Description of the fund.

inception_date: date | None
Inception date of the ETF.

fund_type: str | None
The legal type of fund.

fund_family: str | None
The fund family.

category: str | None
The fund category.

exchange: str | None
The exchange the fund is listed on.

exchange_timezone: str | None
The timezone of the exchange.

currency: str | None
The currency in which the fund is listed.

nav_price: float | None
The net asset value per unit of the fund.

total_assets: int | None
The total value of assets held by the fund.

trailing_pe: float | None
The trailing twelve month P/E ratio of the fund's assets.

dividend_yield: float | None
The dividend yield of the fund, as a normalized percent.

dividend_rate_ttm: float | None
The trailing twelve month annual dividend rate of the fund, in currency units.

dividend_yield_ttm: float | None
The trailing twelve month annual dividend yield of the fund, as a normalized percent.

year_high: float | None
The fifty-two week high price.

year_low: float | None
The fifty-two week low price.

ma_50d: float | None
50-day moving average price.

ma_200d: float | None
200-day moving average price.

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

return_3y_avg: float | None
The three year average return of the fund, as a normalized percent.

return_5y_avg: float | None
The five year average return of the fund, as a normalized percent.

beta_3y_avg: float | None
The three year average beta of the fund.

volume_avg: float | None
The average daily trading volume of the fund.

volume_avg_10d: float | None
The average daily trading volume of the fund over the past ten days.

bid: float | None
The current bid price.

bid_size: float | None
The current bid size.

ask: float | None
The current ask price.

ask_size: float | None
The current ask size.

open: float | None
The open price of the most recent trading session.

high: float | None
The highest price of the most recent trading session.

low: float | None
The lowest price of the most recent trading session.

volume: int | None
The trading volume of the most recent trading session.

prev_close: float | None
The previous closing price.