summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDanglewood <85772166+deeleeramone@users.noreply.github.com>2024-03-13 10:06:11 -0700
committerGitHub <noreply@github.com>2024-03-13 17:06:11 +0000
commitd984637844be34beab090db0b7d3dfd0b4ba419f (patch)
tree1c094cc6d9628374d06ff13c4383de672b23131a
parenta7a7c647b0fbe36cc6d4b574efd3b57d3fcf5a35 (diff)
[Feature] Add Intrinio ETF Info/Search (#6198)
* add intrinio etf info * black * should have been "x-unit_measurement" * field order thing * another field order * review things
-rw-r--r--openbb_platform/extensions/etf/integration/test_etf_api.py8
-rw-r--r--openbb_platform/extensions/etf/integration/test_etf_python.py8
-rw-r--r--openbb_platform/openbb/package/etf.py282
-rw-r--r--openbb_platform/providers/intrinio/openbb_intrinio/__init__.py4
-rw-r--r--openbb_platform/providers/intrinio/openbb_intrinio/models/etf_info.py655
-rw-r--r--openbb_platform/providers/intrinio/openbb_intrinio/models/etf_search.py144
-rw-r--r--openbb_platform/providers/intrinio/openbb_intrinio/utils/references.py24
-rw-r--r--openbb_platform/providers/intrinio/tests/record/http/test_intrinio_fetchers/test_intrinio_etf_info_fetcher.yaml184
-rw-r--r--openbb_platform/providers/intrinio/tests/record/http/test_intrinio_fetchers/test_intrinio_etf_search_fetcher.yaml621
-rw-r--r--openbb_platform/providers/intrinio/tests/test_intrinio_fetchers.py20
10 files changed, 1928 insertions, 22 deletions
diff --git a/openbb_platform/extensions/etf/integration/test_etf_api.py b/openbb_platform/extensions/etf/integration/test_etf_api.py
index 0baccbd72b0..b53b4bfb2b1 100644
--- a/openbb_platform/extensions/etf/integration/test_etf_api.py
+++ b/openbb_platform/extensions/etf/integration/test_etf_api.py
@@ -32,6 +32,13 @@ def headers():
"use_cache": False,
}
),
+ (
+ {
+ "query": "vanguard",
+ "provider": "intrinio",
+ "exchange": "arcx",
+ }
+ ),
],
)
@pytest.mark.integration
@@ -235,6 +242,7 @@ def test_etf_historical(params, headers):
({"symbol": "IOO", "provider": "fmp"}),
({"symbol": "XIU", "provider": "tmx", "use_cache": False}),
({"symbol": "QQQ", "provider": "yfinance"}),
+ ({"symbol": "IOO,QQQ", "provider": "intrinio"}),
],
)
@pytest.mark.integration
diff --git a/openbb_platform/extensions/etf/integration/test_etf_python.py b/openbb_platform/extensions/etf/integration/test_etf_python.py
index 9329a1cdada..6f76921edb5 100644
--- a/openbb_platform/extensions/etf/integration/test_etf_python.py
+++ b/openbb_platform/extensions/etf/integration/test_etf_python.py
@@ -31,6 +31,13 @@ def obb(pytestconfig): # pylint: disable=inconsistent-return-statements
"use_cache": False,
}
),
+ (
+ {
+ "query": "vanguard",
+ "provider": "intrinio",
+ "exchange": "arcx",
+ }
+ ),
],
)
@pytest.mark.integration
@@ -230,6 +237,7 @@ def test_etf_historical(params, obb):
({"symbol": "IOO", "provider": "fmp"}),
({"symbol": "XIU", "provider": "tmx", "use_cache": False}),
({"symbol": "QQQ", "provider": "yfinance"}),
+ ({"symbol": "IOO,QQQ", "provider": "intrinio"}),
],
)
@pytest.mark.integration
diff --git a/openbb_platform/openbb/package/etf.py b/openbb_platform/openbb/package/etf.py
index b34a947e092..b9476ed5e6a 100644
--- a/openbb_platform/openbb/package/etf.py
+++ b/openbb_platform/openbb/package/etf.py
@@ -778,11 +778,11 @@ class ROUTER_etf(Container):
symbol: Annotated[
Union[str, List[str]],
OpenBBCustomParameter(
- description="Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp, yfinance."
+ description="Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp, intrinio, yfinance."
),
],
provider: Annotated[
- Optional[Literal["fmp", "yfinance"]],
+ Optional[Literal["fmp", "intrinio", "yfinance"]],
OpenBBCustomParameter(
description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' if there is\n no default."
),
@@ -794,8 +794,8 @@ class ROUTER_etf(Container):
Parameters
----------
symbol : Union[str, List[str]]
- Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp, yfinance.
- provider : Optional[Literal['fmp', 'yfinance']]
+ Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp, intrinio, yfinance.
+ provider : Optional[Literal['fmp', 'intrinio', 'yfinance']]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'fmp' if there is
no default.
@@ -805,7 +805,7 @@ class ROUTER_etf(Container):
OBBject
results : List[EtfInfo]
Serializable results.
- provider : Optional[Literal['fmp', 'yfinance']]
+ provider : Optional[Literal['fmp', 'intrinio', 'yfinance']]
Provider name.
warnings : Optional[List[Warning_]]
List of warnings.
@@ -825,15 +825,19 @@ class ROUTER_etf(Container):
inception_date : Optional[str]
Inception date of the ETF.
issuer : Optional[str]
- Company of the ETF. (provider: fmp)
+ Company of the ETF. (provider: fmp);
+ Issuer of the ETF. (provider: intrinio)
cusip : Optional[str]
CUSIP of the ETF. (provider: fmp)
isin : Optional[str]
- ISIN of the ETF. (provider: fmp)
+ ISIN of the ETF. (provider: fmp);
+ International Securities Identification Number (ISIN). (provider: intrinio)
domicile : Optional[str]
- Domicile of the ETF. (provider: fmp)
+ Domicile of the ETF. (provider: fmp);
+ 2 letter ISO country code for the country where the ETP is domiciled. (provider: intrinio)
asset_class : Optional[str]
- Asset class of the ETF. (provider: fmp)
+ Asset class of the ETF. (provider: fmp);
+ Captures the underlying nature of the securities in the Exchanged Traded Product (ETP). (provider: intrinio)
aum : Optional[float]
Assets under management. (provider: fmp)
nav : Optional[float]
@@ -848,14 +852,232 @@ class ROUTER_etf(Container):
Average daily trading volume. (provider: fmp)
website : Optional[str]
Website of the issuer. (provider: fmp)
- fund_type : Optional[str]
- The legal type of fund. (provider: yfinance)
+ fund_listing_date : Optional[date]
+ The date on which the Exchange Traded Product (ETP) or share class of the ETP is listed on a specific exchange. (provider: intrinio)
+ data_change_date : Optional[date]
+ The last date on which there was a change in a classifications data field for this ETF. (provider: intrinio)
+ etn_maturity_date : Optional[date]
+ If the product is an ETN, this field identifies the maturity date for the ETN. (provider: intrinio)
+ is_listed : Optional[bool]
+ If true, the ETF is still listed on an exchange. (provider: intrinio)
+ close_date : Optional[date]
+ The date on which the ETF was de-listed if it is no longer listed. (provider: intrinio)
+ exchange : Optional[str]
+ The exchange Market Identifier Code (MIC). (provider: intrinio);
+ The exchange the fund is listed on. (provider: yfinance)
+ ric : Optional[str]
+ Reuters Instrument Code (RIC). (provider: intrinio)
+ sedol : Optional[str]
+ Stock Exchange Daily Official List (SEDOL). (provider: intrinio)
+ figi_symbol : Optional[str]
+ Financial Instrument Global Identifier (FIGI) symbol. (provider: intrinio)
+ share_class_figi : Optional[str]
+ Financial Instrument Global Identifier (FIGI). (provider: intrinio)
+ firstbridge_id : Optional[str]
+ The FirstBridge unique identifier for the Exchange Traded Fund (ETF). (provider: intrinio)
+ firstbridge_parent_id : Optional[str]
+ The FirstBridge unique identifier for the parent Exchange Traded Fund (ETF), if applicable. (provider: intrinio)
+ intrinio_id : Optional[str]
+ Intrinio unique identifier for the security. (provider: intrinio)
+ intraday_nav_symbol : Optional[str]
+ Intraday Net Asset Value (NAV) symbol. (provider: intrinio)
+ primary_symbol : Optional[str]
+ 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. (provider: intrinio)
+ etp_structure_type : Optional[str]
+ Classifies Exchange Traded Products (ETPs) into very broad categories based on its legal structure. (provider: intrinio)
+ legal_structure : Optional[str]
+ Legal structure of the fund. (provider: intrinio)
+ etn_issuing_bank : Optional[str]
+ If the product is an Exchange Traded Note (ETN), this field identifies the issuing bank. (provider: intrinio)
fund_family : Optional[str]
+ This field identifies the fund family to which the ETF belongs, as categorized by the ETF Sponsor. (provider: intrinio);
The fund family. (provider: yfinance)
+ investment_style : Optional[str]
+ Investment style of the ETF. (provider: intrinio)
+ derivatives_based : Optional[str]
+ This field is populated if the ETF holds either listed or over-the-counter derivatives in its portfolio. (provider: intrinio)
+ other_asset_types : Optional[str]
+ If 'asset_class' field is classified as 'Other Asset Types' this field captures the specific category of the underlying assets. (provider: intrinio)
+ single_category_designation : Optional[str]
+ 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. (provider: intrinio)
+ beta_type : Optional[str]
+ 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. (provider: intrinio)
+ beta_details : Optional[str]
+ This field provides further detail within the traditional and smart beta categories. (provider: intrinio)
+ market_cap_range : Optional[str]
+ 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.) (provider: intrinio)
+ market_cap_weighting_type : Optional[str]
+ 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. (provider: intrinio)
+ index_weighting_scheme : Optional[str]
+ For ETFs that track an underlying index, this field provides detail on the index weighting type. (provider: intrinio)
+ index_linked : Optional[str]
+ This field identifies whether an ETF is index linked or active. (provider: intrinio)
+ index_name : Optional[str]
+ This field identifies the name of the underlying index tracked by the ETF, if applicable. (provider: intrinio)
+ index_symbol : Optional[str]
+ This field identifies the OpenFIGI ticker for the Index underlying the ETF. (provider: intrinio)
+ parent_index : Optional[str]
+ 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. (provider: intrinio)
+ index_family : Optional[str]
+ 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. (provider: intrinio)
+ broader_index_family : Optional[str]
+ 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. (provider: intrinio)
+ index_provider : Optional[str]
+ This field identifies the Index provider for the index underlying the ETF, if applicable. (provider: intrinio)
+ index_provider_code : Optional[str]
+ This field provides the First Bridge code for each Index provider, corresponding to the index underlying the ETF if applicable. (provider: intrinio)
+ replication_structure : Optional[str]
+ The replication structure of the Exchange Traded Product (ETP). (provider: intrinio)
+ growth_value_tilt : Optional[str]
+ 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'. (provider: intrinio)
+ growth_type : Optional[str]
+ 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. (provider: intrinio)
+ value_type : Optional[str]
+ 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. (provider: intrinio)
+ sector : Optional[str]
+ 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. (provider: intrinio)
+ industry : Optional[str]
+ For equity ETFs that aim to provide targeted exposure to an industry, this field identifies the Industry that it provides the exposure to. (provider: intrinio)
+ industry_group : Optional[str]
+ 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. (provider: intrinio)
+ cross_sector_theme : Optional[str]
+ 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.) (provider: intrinio)
+ natural_resources_type : Optional[str]
+ 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. (provider: intrinio)
+ us_or_excludes_us : Optional[str]
+ Takes the value of 'Domestic' for US exposure, 'International' for non-US exposure and 'Global' for exposure that includes all regions including the US. (provider: intrinio)
+ developed_emerging : Optional[str]
+ This field identifies the stage of development of the markets that the ETF provides exposure to. (provider: intrinio)
+ specialized_region : Optional[str]
+ 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.) (provider: intrinio)
+ continent : Optional[str]
+ This field is populated if the ETF provides targeted exposure to a specific continent or country within that Continent. (provider: intrinio)
+ latin_america_sub_group : Optional[str]
+ For ETFs that are classified as 'Latin America' in the 'continent' field, this field provides further detail on the type of regional exposure. (provider: intrinio)
+ europe_sub_group : Optional[str]
+ For ETFs that are classified as 'Europe' in the 'continent' field, this field provides further detail on the type of regional exposure. (provider: intrinio)
+ asia_sub_group : Optional[str]
+ For ETFs that are classified as 'Asia' in the 'continent' field, this field provides further detail on the type of regional exposure. (provider: intrinio)
+ specific_country : Optional[str]
+ This field is populated if the ETF provides targeted exposure to a specific country. (provider: intrinio)
+ china_listing_location : Optional[str]
+ 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. (provider: intrinio)
+ us_state : Optional[str]
+ Takes the value of a US state if the ETF provides targeted exposure to the municipal bonds or equities of companies. (provider: intrinio)
+ real_estate : Optional[str]
+ 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. (provider: intrinio)
+ fundamental_weighting_type : Optional[str]
+ For ETFs that take the value 'Fundamental Weighted' in the 'index_weighting_scheme' field, this field provides detail on the fundamental weighting methodology. (provider: intrinio)
+ dividend_weighting_type : Optional[str]
+ For ETFs that take the value 'Dividend Weighted' in the 'index_weighting_scheme' field, this field provides detail on the dividend weighting methodology. (provider: intrinio)
+ bond_type : Optional[str]
+ For ETFs where 'asset_class_type' is 'Bonds', this field provides detail on the type of bonds held in the ETF. (provider: intrinio)
+ government_bond_types : Optional[str]
+ For bond ETFs that take the value 'Treasury & Government' in 'bond_type', this field provides detail on the exposure. (provider: intrinio)
+ municipal_bond_region : Optional[str]
+ For bond ETFs that take the value 'Municipal' in 'bond_type', this field provides additional detail on the geographic exposure. (provider: intrinio)
+ municipal_vrdo : Optional[bool]
+ 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. (provider: intrinio)
+ mortgage_bond_types : Optional[str]
+ For bond ETFs that take the value 'Mortgage' in 'bond_type', this field provides additional detail on the type of underlying securities. (provider: intrinio)
+ bond_tax_status : Optional[str]
+ For all US bond ETFs, this field provides additional detail on the tax treatment of the underlying securities. (provider: intrinio)
+ credit_quality : Optional[str]
+ For all bond ETFs, this field helps to identify if the ETF provides targeted exposure to securities of a specific credit quality range. (provider: intrinio)
+ average_maturity : Optional[str]
+ For all bond ETFs, this field helps to identify if the ETF provides targeted exposure to securities of a specific maturity range. (provider: intrinio)
+ specific_maturity_year : Optional[int]
+ For all bond ETFs that take the value 'Specific Maturity Year' in the 'average_maturity' field, this field specifies the calendar year. (provider: intrinio)
+ commodity_types : Optional[str]
+ For ETFs where 'asset_class_type' is 'Commodities', this field provides detail on the type of commodities held in the ETF. (provider: intrinio)
+ energy_type : Optional[str]
+ For ETFs where 'commodity_type' is 'Energy', this field provides detail on the type of energy exposure provided by the ETF. (provider: intrinio)
+ agricultural_type : Optional[str]
+ For ETFs where 'commodity_type' is 'Agricultural', this field provides detail on the type of agricultural exposure provided by the ETF. (provider: intrinio)
+ metal_type : Optional[str]
+ For ETFs where 'commodity_type' is 'Gold & Metals', this field provides detail on the type of exposure provided by the ETF. (provider: intrinio)
+ inverse_leveraged : Optional[str]
+ This field is populated if the ETF provides inverse or leveraged exposure. (provider: intrinio)
+ target_date_multi_asset_type : Optional[str]
+ For ETFs where 'asset_class_type' is 'Target Date / MultiAsset', this field provides detail on the type of commodities held in the ETF. (provider: intrinio)
+ currency_pair : Optional[str]
+ This field is populated if the ETF's strategy involves providing exposure to the movements of a currency or involves hedging currency exposure. (provider: intrinio)
+ social_environmental_type : Optional[str]
+ This field is populated if the ETF's strategy involves providing exposure to a specific social or environmental theme. (provider: intrinio)
+ clean_energy_type : Optional[str]
+ This field is populated if the ETF has a value of 'Clean Energy' in the 'social_environmental_type' field. (provider: intrinio)
+ dividend_type : Optional[str]
+ This field is populated if the ETF has an intended investment objective of holding dividend-oriented stocks as stated in the prospectus. (provider: intrinio)
+ regular_dividend_payor_type : Optional[str]
+ This field is populated if the ETF has a value of'Dividend - Regular Payors' in the 'dividend_type' field. (provider: intrinio)
+ excludes_financials : Optional[bool]
+ For equity ETFs, identifies those ETFs where the underlying fund holdings will not hold financials stocks, based on the funds intended objective. (provider: intrinio)
+ excludes_technology : Optional[bool]
+ For equity ETFs, identifies those ETFs where the underlying fund holdings will not hold technology stocks, based on the funds intended objective. (provider: intrinio)
+ holds_only_nyse_stocks : Optional[bool]
+ If true, the ETF is an equity ETF and holds only stocks listed on NYSE. (provider: intrinio)
+ holds_only_nasdaq_stocks : Optional[bool]
+ If true, the ETF is an equity ETF and holds only stocks listed on Nasdaq. (provider: intrinio)
+ holds_mlp : Optional[bool]
+ If true, the ETF's investment objective explicitly specifies that it holds MLPs as an intended part of its investment strategy. (provider: intrinio)
+ holds_preferred_stock : Optional[bool]
+ If true, the ETF's investment objective explicitly specifies that it holds preferred stock as an intended part of its investment strategy. (provider: intrinio)
+ holds_closed_end_funds : Optional[bool]
+ If true, the ETF's investment objective explicitly specifies that it holds closed end funds as an intended part of its investment strategy. (provider: intrinio)
+ holds_adr : Optional[bool]
+ If true, he ETF's investment objective explicitly specifies that it holds American Depositary Receipts (ADRs) as an intended part of its investment strategy. (provider: intrinio)
+ laddered : Optional[bool]
+ 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. (provider: intrinio)
+ zero_coupon : Optional[bool]
+ For bond ETFs, this field identifies those ETFs that specifically hold zero coupon Treasury Bills. (provider: intrinio)
+ floating_rate : Optional[bool]
+ For bond ETFs, this field identifies those ETFs that specifically hold floating rate bonds. (provider: intrinio)
+ build_america_bonds : Optional[bool]
+ For municipal bond ETFs, this field identifies those ETFs that specifically hold Build America Bonds. (provider: intrinio)
+ dynamic_futures_roll : Optional[bool]
+ 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. (provider: intrinio)
+ currency_hedged : Optional[bool]
+ This field is populated if the ETF's strategy involves hedging currency exposure. (provider: intrinio)
+ includes_short_exposure : Optional[bool]
+ This field is populated if the ETF has short exposure in any of its holdings e.g. in a long/short or inverse ETF. (provider: intrinio)
+ ucits : Optional[bool]
+ If true, the Exchange Traded Product (ETP) is Undertakings for the Collective Investment in Transferable Securities (UCITS) compliant (provider: intrinio)
+ quant_strategies_type : Optional[str]
+ This field is populated if the ETF has either an index-linked or active strategy that is based on a proprietary quantitative strategy. (provider: intrinio)
+ other_quant_models : Optional[str]
+ 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. (provider: intrinio)
+ hedge_fund_type : Optional[str]
+ For ETFs where 'other_asset_types' is 'Hedge Fund Replication', this field provides detail on the type of hedge fund replication strategy. (provider: intrinio)
+ livestock : Optional[str]
+ For ETFs where 'commodity_type' is 'Livestock', this field provides detail on the type of livestock exposure provided by the ETF. (provider: intrinio)
+ registered_countries : Optional[str]
+ 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. (provider: intrinio)
+ issuer_country : Optional[str]
+ 2 letter ISO country code for the country where the issuer is located. (provider: intrinio)
+ listing_country : Optional[str]
+ 2 letter ISO country code for the country of the primary listing. (provider: intrinio)
+ listing_region : Optional[str]
+ Geographic region in the country of the primary listing falls. (provider: intrinio)
+ bond_currency_denomination : Optional[str]
+ For all bond ETFs, this field provides additional detail on the currency denomination of the underlying securities. (provider: intrinio)
+ base_currency : Optional[str]
+ Base currency in which NAV is reported. (provider: intrinio)
+ listing_currency : Optional[str]
+ Listing currency of the Exchange Traded Product (ETP) in which it is traded. Reported using the 3-digit ISO currency code. (provider: intrinio)
+ income_category : Optional[str]
+ Identifies if an Exchange Traded Fund (ETF) falls into a category that is specifically designed to provide a high yield or income (provider: intrinio)
+ number_of_holdings : Optional[int]
+ The number of holdings in the ETF. (provider: intrinio)
+ month_end_assets : Optional[float]
+ Net assets in millions of dollars as of the most recent month end. (provider: intrinio)
+ net_expense_ratio : Optional[float]
+ Gross expense net of Fee Waivers, as a percentage of net assets as published by the ETF issuer. (provider: intrinio)
+ etf_portfolio_turnover : Optional[float]
+ The percentage of positions turned over in the last 12 months. (provider: intrinio)
+ fund_type : Optional[str]
+ The legal type of fund. (provider: yfinance)
category : Optional[str]
The fund category. (provider: yfinance)
- exchange : Optional[str]
- The exchange the fund is listed on. (provider: yfinance)
exchange_timezone : Optional[str]
The timezone of the exchange. (provider: yfinance)
currency : Optional[str]
@@ -926,14 +1148,18 @@ class ROUTER_etf(Container):
"provider": self._get_provider(
provider,
"/etf/info",
- ("fmp", "yfinance"),
+ ("fmp", "intrinio", "yfinance"),
)
},
standard_params={
"symbol": symbol,
},
extra_params=kwargs,
- extra_info={"symbol": {"multiple_items_allowed": ["fmp", "yfinance"]}},
+ extra_info={
+ "symbol": {
+ "multiple_items_allowed": ["fmp", "intrinio", "yfinance"]
+ }
+ },
)
)
@@ -1046,7 +1272,7 @@ class ROUTER_etf(Container):
Optional[str], OpenBBCustomParameter(description="Search query.")
] = "",
provider: Annotated[
- Optional[Literal["fmp"]],
+ Optional[Literal["fmp", "intrinio"]],
OpenBBCustomParameter(
description="The provider to use for the query, by default None.\n If None, the provider specified in defaults is selected or 'fmp' if there is\n no default."
),
@@ -1062,12 +1288,13 @@ class ROUTER_etf(Container):
----------
query : Optional[str]
Search query.
- provider : Optional[Literal['fmp']]
+ provider : Optional[Literal['fmp', 'intrinio']]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'fmp' if there is
no default.
- exchange : Optional[Literal['AMEX', 'NYSE', 'NASDAQ', 'ETF', 'TSX', 'EURONEXT']]
- The exchange code the ETF trades on. (provider: fmp)
+ exchange : Optional[Union[Literal['AMEX', 'NYSE', 'NASDAQ', 'ETF', 'TSX', 'EURONEXT'], Literal['xnas', 'arcx', 'bats', 'xnys', 'bvmf', 'xshg', 'xshe', 'xhkg', 'xbom', 'xnse', 'xidx', 'tase', 'xkrx', 'xkls', 'xmex', 'xses', 'roco', 'xtai', 'xbkk', 'xist']]]
+ The exchange code the ETF trades on. (provider: fmp);
+ Target a specific exchange by providing the MIC code. (provider: intrinio)
is_active : Optional[Literal[True, False]]
Whether the ETF is actively trading. (provider: fmp)
@@ -1076,7 +1303,7 @@ class ROUTER_etf(Container):
OBBject
results : List[EtfSearch]
Serializable results.
- provider : Optional[Literal['fmp']]
+ provider : Optional[Literal['fmp', 'intrinio']]
Provider name.
warnings : Optional[List[Warning_]]
List of warnings.
@@ -1106,13 +1333,24 @@ class ROUTER_etf(Container):
volume : Optional[float]
The current trading volume of the ETF. (provider: fmp)
exchange : Optional[str]
- The exchange code the ETF trades on. (provider: fmp)
+ The exchange code the ETF trades on. (provider: fmp);
+ The exchange MIC code. (provider: intrinio)
exchange_name : Optional[str]
The full name of the exchange the ETF trades on. (provider: fmp)
country : Optional[str]
The country the ETF is registered in. (provider: fmp)
actively_trading : Optional[Literal[True, False]]
Whether the ETF is actively trading. (provider: fmp)
+ figi_ticker : Optional[str]
+ The OpenFIGI ticker. (provider: intrinio)
+ ric : Optional[str]
+ The Reuters Instrument Code. (provider: intrinio)
+ isin : Optional[str]
+ The International Securities Identification Number. (provider: intrinio)
+ sedol : Optional[str]
+ The Stock Exchange Daily Official List. (provider: intrinio)
+ intrinio_id : Optional[str]
+ The unique Intrinio ID for the security. (provider: intrinio)
Examples
--------
@@ -1130,7 +1368,7 @@ class ROUTER_etf(Container):
"provider": self._get_provider(
provider,
"/etf/search",
- ("fmp",),
+ ("fmp", "intrinio"),
)
},
standard_params={
diff --git a/openbb_platform/providers/intrinio/openbb_intrinio/__init__.py b/openbb_platform/providers/intrinio/openbb_intrinio/__init__.py
index 33f4fcca881..be7cb40870d 100644
--- a/openbb_platform/providers/intrinio/openbb_intrinio/__init__.py
+++ b/openbb_platform/providers/intrinio/openbb_intrinio/__init__.py
@@ -11,6 +11,8 @@ from openbb_intrinio.models.equity_historical import IntrinioEquityHistoricalFet
from openbb_intrinio.models.equity_info import IntrinioEquityInfoFetcher
from openbb_intrinio.models.equity_quote import Intrini