Lookup ETF

Lookup ETF Ruby API Documentation

Returns classifications and reference data which consists of ~90 columns that give detailed information about an ETF. These granular details include asset class, expense ratio, index name, index weighting scheme, smart beta type and specific investment objectives.

API Class:
Intrinio::ETFsApi
Instance Method:
get_etf()

Stock Price Code Example

Use my API Key
# Load the gem
require 'intrinio-sdk'
require 'pp'
# Setup authorization
Intrinio.configure do |config|
config.api_key['api_key'] = 'YOUR_API_KEY'
config.allow_retries = true
end
eTFs_api = Intrinio::ETFsApi.new
identifier = "SPY"
result = eTFs_api.get_etf(identifier)
pp result
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Parameters

NameTypeDescriptionNotes
identifierStringAn ETF identifier (Ticker, Figi Ticker, ISIN, RIC, Intrinio ID) 

Return Type

object
Intrinio::ETF

Properties

NameTypeDescription
idStringThe Intrinio ID of the ETF  
nameStringThe common name of the ETF  
tickerStringThe common ticker symbol for the ETF  
figi_tickerStringThe OpenFIGI ticker for the ETF  
ricStringReuters Instrument Code (RIC) for the ETF  
isinStringInternational Securities Identification Number (ISIN) for the ETF  
sedolStringStock Exchange Daily Official List (SEDOL) for the ETF  
exchange_micStringThe exchange Market Identifier Code (MIC) from the International Standards Organization (ISO)  
sponsorStringThe fund manager (ETF) or issuing bank (ETN)  
typeStringHigh-level classification for the ETF based on its intended investment objective  
descriptionStringThe ETF description as published by the ETF sponsor  
inception_dateDateInception Date for the ETF as published by the ETF sponsor  
data_change_dateDateThe last date on which there was a change in a classifications data field for this ETF  
close_dateDateThe date on which this ETF was de-listed if it is no longer listed  
is_live_listedBOOLEANIf true, the ETF is still listed on an exchange; if false, the ETF is no longer listed  
legal_structureStringThe legal structure as defined in the prospectus  
intraday_nav_tickerStringIntra-day NAV ticker for the Exchange Traded Fund (ETF)  
primary_tickerStringThe 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  
primary_ticker_country_codeString2 letter ISO country code for the country of the primary listing  
primary_listing_regionStringGeographic region in the country of the primary listing falls  
net_expense_ratioFloatGross expense net of Fee Waivers, as a percentage of net assets as published by the ETF Sponsor  
asset_classStringCaptures the underlying nature of the securities in the Exchanged Traded Product (ETP)  
other_asset_typesStringIf ‘asset_class' field is classified as ‘Other Asset Types' this field captures the specific category of the underlying assets  
market_cap_rangeStringEquity 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.)  
holds_only_nyse_stocksBOOLEANIf true, the ETF is an equity ETF and holds only stocks listed on NYSE  
holds_only_nasdaq_stocksBOOLEANIf false, the ETF is an equity ETF and holds only stocks listed on Nasdaq  
growth_value_tiltStringClassifies 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_typeStringFor 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_typeStringFor 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  
sectorStringFor equity ETFs that aim to provide targeted exposure to a sector or industry, this field identifies the Sector that it provides the exposure to  
industryStringFor equity ETFs that aim to provide targeted exposure to an industry, this field identifies the Industry that it provides the exposure to.  
sub_industryStringFor 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_themeStringFor 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_typeStringFor 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.  
excludes_financialsBOOLEANFor equity ETFs, identifies those ETFs where the underlying fund holdings will not hold financials stocks, based on the funds intended objective  
excludes_technologyBOOLEANFor equity ETFs, identifies those ETFs where the underlying fund holdings will not hold technology stocks, based on the funds intended objective  
us_or_excludes_usStringTakes the value of ‘Domestic' for US exposure, ‘International' for non-US exposure and ‘Global' for exposure that includes all regions including the US  
developed_emergingStringThis field identifies the stage of development of the markets that the ETF provides exposure to  
specialized_regionStringThis 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.)  
continentStringThis field is populated if the ETF provides targeted exposure to a specific continent or country within that Continent  
latin_america_sub_groupStringFor ETFs that are classified as ‘Latin America' in the ‘continent' field, this field provides further detail on the type of regional exposure  
europe_sub_groupStringFor ETFs that are classified as ‘Europe' in the ‘continent' field, this field provides further detail on the type of regional exposure  
asia_sub_groupStringFor ETFs that are classified as ‘Asia' in the ‘continent' field, this field provides further detail on the type of regional exposure  
specific_countryStringThis field is populated if the ETF provides targeted exposure to a specific country  
china_listing_locationStringFor 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_stateStringTakes the value of a US state if the ETF provides targeted exposure to the municipal bonds or equities of companies operating in a specific state in the US  
real_estateStringFor 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  
index_weighting_schemeStringFor ETFs that track an underlying index, this field provides detail on the index weighting type  
market_cap_weighting_typeStringFor ETFs that take the value ‘Market Cap Weighted' in the ‘index_weighting_scheme' field, this field provides detail on the market cap weighting type  
fundamental_weighting_typeStringFor ETFs that take the value ‘Fundamental Weighted' in the ‘index_weighting_scheme' field, this field provides detail on the fundamental weighting methodology  
dividend_weighting_typeStringFor ETFs that take the value ‘Dividend Weighted' in the ‘index_weighting_scheme' field, this field provides detail on the dividend weighting methodology  
bond_typeStringFor ETFs where ‘asset_class_type' is 'Bonds', this field provides detail on the type of bonds held in the ETF  
government_bond_typesStringFor bond ETFs that take the value ‘Treasury & Government' in 'bond_type', this field provides detail on the exposure  
municipal_bond_regionStringFor bond ETFs that take the value ‘Municipal' in 'bond_type', this field provides additional detail on the geographic exposure  
municipal_vrdoBOOLEANFor 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_typesStringFor bond ETFs that take the value ‘Mortgage' in 'bond_type', this field provides additional detail on the type of underlying securities  
bond_tax_statusStringFor all US bond ETFs, this field provides additional detail on the tax treatment of the underlying securities  
credit_qualityStringFor all bond ETFs, this field helps to identify if the ETF provides targeted exposure to securities of a specific credit quality range  
average_maturityStringFor all bond ETFs, this field helps to identify if the ETF provides targeted exposure to securities of a specific maturity range  
specific_maturity_yearIntegerFor all bond ETFs that take the value ‘Specific Maturity Year' in the ‘average_maturity' field, this field specifies the calendar year  
bond_currency_denominationStringFor all bond ETFs, this field provides additional detail on the currency denomination of the underlying securities  
ladderedBOOLEANFor 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_couponBOOLEANFor bond ETFs, this field identifies those ETFs that specifically hold zero coupon Treasury Bills  
floating_rateBOOLEANFor bond ETFs, this field identifies those ETFs that specifically hold floating rate bonds  
build_america_bondsBOOLEANFor municipal bond ETFs, this field identifies those ETFs that specifically hold Build America Bonds  
commodity_typesStringFor ETFs where ‘asset_class_type' is 'Commodities', this field provides detail on the type of commodities held in the ETF  
energy_typeStringFor ETFs where ‘commodity_type' is 'Energy', this field provides detail on the type of energy exposure provided by the ETF  
agricultural_typeStringFor ETFs where ‘commodity_type' is 'Agricultural', this field provides detail on the type of agricultural exposure provided by the ETF  
metal_typeStringFor ETFs where ‘commodity_type' is 'Gold & Metals', this field provides detail on the type of exposure provided by the ETF  
inverse_leveragedStringThis field is populated if the ETF provides inverse or leveraged exposure  
target_date_multi_asset_typeStringFor ETFs where ‘asset_class_type' is 'Target Date / MultiAsset', this field provides detail on the type of commodities held in the ETF  
currency_hedgedBOOLEANThis field is populated if the ETF's strategy involves hedging currency exposure  
currency_pairStringThis field is populated if the ETF's strategy involves providing exposure to the movements of a currency or involves hedging currency exposure  
social_environmental_typeStringThis field is populated if the ETF's strategy involves providing exposure to a specific social or environmental theme  
clean_energy_typeStringThis field is populated if the ETF has a value of ‘Clean Energy' in the ‘social_environmental_type' field.  
dividend_typeStringThis field is populated if the ETF has an intended investment objective of holding dividend-oriented stocks as stated in the prospectus  
regular_dividend_payor_typeStringThis field is populated if the ETF has a value of ‘Dividend – Regular Payors' in the ‘dividend_type' field  
holds_ml_psBOOLEANIf true, the ETF's investment objective explicitly specifies that it holds MLPs as an intended part of its investment strategy  
holds_preferred_stockBOOLEANIf true, the ETF's investment objective explicitly specifies that it holds preferred stock as an intended part of its investment strategy  
holds_closed_end_fundsBOOLEANIF true, if the ETF's investment objective explicitly specifies that it holds closed end funds as an intended part of its investment strategy  
quant_strategies_typeStringThis field is populated if the ETF has either an index-linked or active strategy that is based on a proprietary quantitative strategy  
other_quant_modelsStringFor 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_typeStringFor ETFs where ‘other_asset_types' is 'Hedge Fund Replication', this field provides detail on the type of hedge fund replication strategy  
derivatives_basedStringThis field is populated if the ETF holds either listed or over-the-counter derivatives in its portfolio  
holds_ad_rsBOOLEANIf true, he ETF's investment objective explicitly specifies that it holds American Depositary Receipts (ADRs) as an intended part of its investment strategy  
index_linkedStringThis field identifies whether an ETF is index linked or active  
includes_short_exposureBOOLEANThis field is populated if the ETF has short exposure in any of its holdings e.g. in a long/short or inverse ETF  
index_nameStringThis field identifies the name of the underlying index tracked by the ETF, if applicable  
parent_indexStringThis 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_familyStringThis 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_familyStringThis 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_providerStringThis field identifies the Index provider for the index underlying the ETF, if applicable  
fund_familyStringThis field identifies the fund family to which the ETF belongs, as categorized by the ETF Sponsor  
index_tickerStringThis field identifies the OpenFIGI ticker for the Index underlying the ETF  
etn_issuing_bankStringIf the product is an Exchange Traded Note (ETN), this field identifies the issuing bank  
etn_maturity_dateDateIf the product is an ETN, this field identifies the maturity date for the ETN  
livestockStringFor ETFs where ‘commodity_type' is 'Livestock', this field provides detail on the type of livestock exposure provided by the ETF  
dynamic_futures_rollBOOLEANIf 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  
index_provider_codeStringThis field provides the First Bridge code for each Index provider, corresponding to the index underlying the ETF if applicable  
single_category_designationStringThis 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  
registered_countriesStringThe 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  
issuing_entity_country_codeStringThe name of the legal entity that issued the Exchange Traded Product (ETP)  
ucitsBOOLEANIf true, the Exchange Traded Product (ETP) is Undertakings for the Collective Investment in Transferable Securities (UCITS) compliant  
replication_structureStringThe replication structure of the Exchange Traded Product (ETP)  
domicileString2 letter ISO country code for the country where the ETP is domiciled  
base_currencyStringBase currency of the Exchange Traded Product (ETP) in which the net asset value (NAV) is calculated. Reported using the 3-digit ISO currency code  
listing_currencyStringListing currency of the Exchange Traded Product (ETP) in which it is traded. Reported using the 3-digit ISO currency code  
fund_listing_dateDateThe date on which the Exchange Traded Product (ETP) or share class of the ETP is listed on a specific exchange  
listing_country_codeString2 letter ISO country code for the country where the Exchange Traded Product (ETP) is listed  
listing_regionStringThe region in which this specific ETF is listed  
smartvs_traditional_betaStringThis 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  
smartvs_traditional_beta_level2StringThis field provides further detail within the traditional and smart beta categories  
income_categoryStringIdentifies if an Exchange Traded Fund (ETF) falls into a category that is specifically designed to provide a high yield or income  
etp_structure_typeStringClassifies Exchange Traded Products (ETPs) into very broad categories based on its legal structure  
month_end_assetsFloatNet assets in millions of dollars as of the most recent month end  
etf_portfolio_turnoverFloatThe percentage of positions turned over in the last 12 months  
firstbridge_idStringThe FirstBridge unique identifier for the Exchange Traded Fund (ETF)  
firstbridge_parent_idStringThe FirstBridge unique identifier of the parent Exchange Traded Fund (ETF), if applicable  
number_of_holdingsIntegerThe number of holdings for this Exchange Traded Fund (ETF)