### THIS FILE IS AUTO-GENERATED. DO NOT EDIT. ### from typing import List, Literal, Optional, Union from openbb_core.app.model.custom_parameter import OpenBBCustomParameter from openbb_core.app.model.obbject import OBBject from openbb_core.app.static.container import Container from openbb_core.app.static.utils.decorators import validate from openbb_core.app.static.utils.filters import filter_inputs from typing_extensions import Annotated class ROUTER_etf(Container): """/etf countries holdings holdings_date holdings_performance info price_performance search sectors """ def __repr__(self) -> str: return self.__doc__ or "" @validate def countries( self, symbol: Annotated[ Union[str, List[str]], OpenBBCustomParameter(description="Symbol to get data for. (ETF)"), ], provider: Optional[Literal["fmp"]] = None, **kwargs ) -> OBBject: """ETF Country weighting. Parameters ---------- symbol : str Symbol to get data for. (ETF) provider : Optional[Literal['fmp']] 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. Returns ------- OBBject results : List[EtfCountries] Serializable results. provider : Optional[Literal['fmp']] Provider name. warnings : Optional[List[Warning_]] List of warnings. chart : Optional[Chart] Chart object. extra: Dict[str, Any] Extra info. EtfCountries ------------ country : str The country of the exposure. Corresponding values are normalized percentage points. Example ------- >>> from openbb import obb >>> obb.etf.countries(symbol="AAPL") """ # noqa: E501 return self._run( "/etf/countries", **filter_inputs( provider_choices={ "provider": provider, }, standard_params={ "symbol": ",".join(symbol) if isinstance(symbol, list) else symbol, }, extra_params=kwargs, ) ) @validate def holdings( self, symbol: Annotated[ Union[str, List[str]], OpenBBCustomParameter(description="Symbol to get data for. (ETF)"), ], provider: Optional[Literal["fmp", "sec"]] = None, **kwargs ) -> OBBject: """Get the holdings for an individual ETF. Parameters ---------- symbol : str Symbol to get data for. (ETF) provider : Optional[Literal['fmp', 'sec']] 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. date : Optional[Union[str, datetime.date]] A specific date to get data for. This needs to be _exactly_ the date of the filing. Use the holdings_date command/endpoint to find available filing dates for the ETF. (provider: fmp); A specific date to get data for. The date represents the period ending. The date entered will return the closest filing. (provider: sec) cik : Optional[str] The CIK of the filing entity. Overrides symbol. (provider: fmp) use_cache : bool Whether or not to use cache for the request. (provider: sec) Returns ------- OBBject results : List[EtfHoldings] Serializable results. provider : Optional[Literal['fmp', 'sec']] Provider name. warnings : Optional[List[Warning_]] List of warnings. chart : Optional[Chart] Chart object. extra: Dict[str, Any] Extra info. EtfHoldings ----------- symbol : Optional[str] Symbol representing the entity requested in the data. (ETF) name : Optional[str] Name of the ETF holding. lei : Optional[str] The LEI of the holding. (provider: fmp, sec) title : Optional[str] The title of the holding. (provider: fmp) cusip : Optional[str] The CUSIP of the holding. (provider: fmp, sec) isin : Optional[str] The ISIN of the holding. (provider: fmp, sec) balance : Optional[float] The balance of the holding. (provider: fmp, sec) units : Optional[Union[str, float]] The units of the holding. (provider: fmp, sec) currency : Optional[str] The currency of the holding. (provider: fmp, sec) value : Optional[float] The value of the holding in USD. (provider: fmp, sec) weight : Optional[float] The weight of the holding in ETF in %. (provider: fmp, sec) payoff_profile : Optional[str] The payoff profile of the holding. (provider: fmp, sec) asset_category : Optional[str] The asset category of the holding. (provider: fmp, sec) issuer_category : Optional[str] The issuer category of the holding. (provider: fmp, sec) country : Optional[str] The country of the holding. (provider: fmp, sec) is_restricted : Optional[str] Whether the holding is restricted. (provider: fmp, sec) fair_value_level : Optional[int] The fair value level of the holding. (provider: fmp, sec) is_cash_collateral : Optional[str] Whether the holding is cash collateral. (provider: fmp, sec) is_non_cash_collateral : Optional[str] Whether the holding is non-cash collateral. (provider: fmp, sec) is_loan_by_fund : Optional[str] Whether the holding is loan by fund. (provider: fmp, sec) cik : Optional[str] The CIK of the filing. (provider: fmp) acceptance_datetime : Optional[str] The acceptance datetime of the filing. (provider: fmp) other_id : Optional[str] Internal identifier for the holding. (provider: sec) loan_value : Optional[float] The loan value of the holding. (provider: sec) issuer_conditional : Optional[str] The issuer conditions of the holding. (provider: sec) asset_conditional : Optional[str] The asset conditions of the holding. (provider: sec) maturity_date : Optional[date] The maturity date of the debt security. (provider: sec) coupon_kind : Optional[str] The type of coupon for the debt security. (provider: sec) rate_type : Optional[str] The type of rate for the debt security, floating or fixed. (provider: sec) annualized_return : Optional[float] The annualized return on the debt security. (provider: sec) is_default : Optional[str] If the debt security is defaulted. (provider: sec) in_arrears : Optional[str] If the debt security is in arrears. (provider: sec) is_paid_kind : Optional[str] If the debt security payments are are paid in kind. (provider: sec) derivative_category : Optional[str] The derivative category of the holding. (provider: sec) counterparty : Optional[str] The counterparty of the derivative. (provider: sec) underlying_name : Optional[str] The name of the underlying asset associated with the derivative. (provider: sec) option_type : Optional[str] The type of option. (provider: sec) derivative_payoff : Optional[str] The payoff profile of the derivative. (provider: sec) expiry_date : Optional[date] The expiry or termination date of the derivative. (provider: sec) exercise_price : Optional[float] The exercise price of the option. (provider: sec) exercise_currency : Optional[str] The currency of the option exercise price. (provider: sec) shares_per_contract : Optional[float] The number of shares per contract. (provider: sec) delta : Optional[Union[str, float]] The delta of the option. (provider: sec) rate_type_rec : Optional[str] The type of rate for reveivable portion of the swap. (provider: sec) receive_currency : Optional[str] The receive currency of the swap. (provider: sec) upfront_receive : Optional[float] The upfront amount received of the swap. (provider: sec) floating_rate_index_rec : Optional[str] The floating rate index for reveivable portion of the swap. (provider: sec) floating_rate_spread_rec : Optional[float] The floating rate spread for reveivable portion of the swap. (provider: sec) rate_tenor_rec : Optional[str] The rate tenor for reveivable portion of the swap. (provider: sec) rate_tenor_unit_rec : Optional[Union[str, int]] The rate tenor unit for reveivable portion of the swap. (provider: sec) reset_date_rec : Optional[str] The reset date for reveivable portion of the swap. (provider: sec) reset_date_unit_rec : Optional[Union[str, int]] The reset date unit for reveivable portion of the swap. (provider: sec) rate_type_pmnt : Optional[str] The type of rate for payment portion of the swap. (provider: sec) payment_currency : Optional[str] The payment currency of the swap. (provider: sec) upfront_payment : Optional[float] The upfront amount received of the swap. (provider: sec) floating_rate_index_pmnt : Optional[str] The floating rate index for payment portion of the swap. (provider: sec) floating_rate_spread_pmnt : Optional[float] The floating rate spread for payment portion of the swap. (provider: sec) rate_tenor_pmnt : Optional[str] The rate tenor for payment portion of the swap. (provider: sec) rate_tenor_unit_pmnt : Optional[Union[str, int]] The rate tenor unit for payment portion of the swap. (provider: sec) reset_date_pmnt : Optional[str] The reset date for payment portion of the swap. (provider: sec) reset_date_unit_pmnt : Optional[Union[str, int]] The reset date unit for payment portion of the swap. (provider: sec) repo_type : Optional[str] The type of repo. (provider: sec) is_cleared : Optional[str] If the repo is cleared. (provider: sec) is_tri_party : Optional[str] If the repo is tri party. (provider: sec) principal_amount : Optional[float] The principal amount of the repo. (provider: sec) principal_currency : Optional[str] The currency of the principal amount. (provider: sec) collateral_type : Optional[str] The collateral type of the repo. (provider: sec) collateral_amount : Optional[float] The collateral amount of the repo. (provider: sec) collateral_currency : Optional[str] The currency of the collateral amount. (provider: sec) exchange_currency : Optional[str] The currency of the exchange rate. (provider: sec) exchange_rate : Optional[float] The exchange rate. (provider: sec) currency_sold : Optional[str] The currency sold in a Forward Derivative. (provider: sec) currency_amount_sold : Optional[float] The amount of currency sold in a Forward Derivative. (provider: sec) currency_bought : Optional[str] The currency bought in a Forward Derivative. (provider: sec) currency_amount_bought : Optional[float] The amount of currency bought in a Forward Derivative. (provider: sec) notional_amount : Optional[float] The notional amount of the derivative. (provider: sec) notional_currency : Optional[str] The currency of the derivative's notional amount. (provider: sec) unrealized_gain : Optional[float] The unrealized gain or loss on the derivative. (provider: sec) Example ------- >>> from openbb import obb >>> obb.etf.holdings(symbol="AAPL") """ # noqa: E501 return self._run( "/etf/holdings", **filter_inputs( provider_choices={ "provider": provider, }, standard_params={ "symbol": ",".join(symbol) if isinstance(symbol, list) else symbol, }, extra_params=kwargs, ) ) @validate def holdings_date( self, symbol: Annotated[ Union[str, List[str]], OpenBBCustomParameter(description="Symbol to get data for. (ETF)"), ], provider: Optional[Literal["fmp"]] = None, **kwargs ) -> OBBject: """Get the holdings filing date for an individual ETF. Parameters ---------- symbol : str Symbol to get data for. (ETF) provider : Optional[Literal['fmp']] 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. cik : Optional[str] The CIK of the filing entity. Overrides symbol. (provider: fmp) Returns ------- OBBject results : List[EtfHoldingsDate] Serializable results. provider : Optional[Literal['fmp']] Provider name. warnings : Optional[List[Warning_]] List of warnings. chart : Optional[Chart] Chart object. extra: Dict[str, Any] Extra info. EtfHoldingsDate --------------- date : date The date of the data. Example ------- >>> from openbb import obb >>> obb.etf.holdings_date(symbol="AAPL") """ # noqa: E501 return self._run( "/etf/holdings_date", **filter_inputs( provider_choices={ "provider": provider, }, standard_params={ "symbol": ",".join(symbol) if isinstance(symbol, list) else symbol, }, extra_params=kwargs, ) ) @validate def holdings_performance( self, symbol: Annotated[ Union[str, List[str]], OpenBBCustomParameter(description="Symbol to get data for."), ], provider: Optional[Literal["fmp"]] = None, **kwargs ) -> OBBject: """Get the ETF holdings performance. Parameters ---------- symbol : str Symbol to get data for. provider : Optional[Literal['fmp']] 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. Returns ------- OBBject results : List[EtfHoldingsPerformance] Serializable results. provider : Optional[Literal['fmp']] Provider name. warnings : Optional[List[Warning_]] List of warnings. chart : Optional[Chart] Chart object. extra: Dict[str, Any] Extra info. EtfHoldingsPerformance ---------------------- one_day : Optional[float] One-day return. wtd : Optional[float] Week to date return. one_week : Optional[float] One-week return. mtd : Optional[float] Month to date return. one_month : Optional[float] One-month return. qtd : Optional[float] Quarter to date return. three_month : Optional[float] Three-month return. six_month : Optional[float] Six-month return. ytd : Optional[float] Year to date return. one_year : Optional[float] One-year return. three_year : Optional[float] Three-year return. five_year : Optional[float] Five-year return. ten_year : Optional[float] Ten-year return. max : Optional[float] Return from the beginning of the time series. symbol : Optional[str] The ticker symbol. (provider: fmp) Example ------- >>> from openbb import obb >>> obb.etf.holdings_performance(symbol="AAPL") """ # noqa: E501 return self._run( "/etf/holdings_performance", **filter_inputs( provider_choices={ "provider": provider, }, standard_params={ "symbol": ",".join(symbol) if isinstance(symbol, list) else symbol, }, extra_params=kwargs, ) ) @validate def info( self, symbol: Annotated[ Union[str, List[str]], OpenBBCustomParameter(description="Symbol to get data for. (ETF)"), ], provider: Optional[Literal["fmp"]] = None, **kwargs ) -> OBBject: """ETF Information Overview. Parameters ---------- symbol : str Symbol to get data for. (ETF) provider : Optional[Literal['fmp']] 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. Returns ------- OBBject results : List[EtfInfo] Serializable results. provider : Optional[Literal['fmp']] Provider name. warnings : Optional[List[Warning_]] List of warnings. chart : Optional[Chart] Chart object. extra: Dict[str, Any] Extra info. EtfInfo ------- symbol : str Symbol representing the entity requested in the data. (ETF) name : Optional[str] Name of the ETF. inception_date : Optional[str] Inception date of the ETF. asset_class : Optional[str] Asset class of the ETF. (provider: fmp) aum : Optional[float] Assets under management. (provider: fmp) avg_volume : Optional[float] Average trading volume of the ETF. (provider: fmp) cusip : Optional[str] CUSIP of the ETF. (provider: fmp) description : Optional[str] Description of the ETF. (provider: fmp) domicile : Optional[str] Domicile of the ETF. (provider: fmp) etf_company : Optional[str] Company of the ETF. (provider: fmp) expense_ratio : Optional[float] Expense ratio of the ETF. (provider: fmp) isin : Optional[str] ISIN of the ETF. (provider: fmp) nav : Optional[float] Net asset value of the ETF. (provider: fmp) nav_currency : Optional[str] Currency of the ETF's net asset value. (provider: fmp) website : Optional[str] Website link of the ETF. (provider: fmp) holdings_count : Optional[int] Number of holdings in the ETF. (provider: fmp) Example ------- >>> from openbb import obb >>> obb.etf.info(symbol="AAPL") """ # noqa: E501 return self._run( "/etf/info", **filter_inputs( provider_choices={ "provider": provider, }, standard_params={ "symbol": ",".join(symbol) if isinstance(symbol, list) else symbol, }, extra_params=kwargs, ) ) @validate def price_performance( self, symbol: Annotated[ Union[str, List[str]], OpenBBCustomParameter(description="Symbol to get data for."), ], provider: Optional[Literal["fmp"]] = None, **kwargs ) -> OBBject: """Price performance as a return, over different periods. Parameters ---------- symbol : str Symbol to get data for. provider : Optional[Literal['fmp']] 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. Returns ------- OBBject results : List[PricePerformance] Serializable results. provider : Optional[Literal['fmp']] Provider name. warnings : Optional[List[Warning_]] List of warnings. chart : Optional[Chart] Chart object. extra: Dict[str, Any] Extra info. PricePerformance ---------------- one_day : Optional[float] One-day return. wtd : Optional[float] Week to date return. one_week : Optional[float] One-week return. mtd : Optional[float] Month to date return. one_month : Optional[float] One-month return. qtd : Optional[float] Quarter to date return. three_month : Optional[float] Three-month return. six_month : Optional[float] Six-month return. ytd : Optional[float] Year to date return. one_year : Optional[float] One-year return. three_year : Optional[float] Three-year return. five_year : Optional[float] Five-year return. ten_year : Optional[float] Ten-year return. max : Optional[float] Return from the beginning of the time series. symbol : Optional[str] The ticker symbol. (provider: fmp) Example ------- >>> from openbb import obb >>> obb.equity.price.performance(symbol="AAPL") """ # noqa: E501 return self._run( "/etf/price_performance", **filter_inputs( provider_choices={ "provider": provider, }, standard_params={ "symbol": ",".join(symbol) if isinstance(symbol, list) else symbol, }, extra_params=kwargs, ) ) @validate def search( self, query: Annotated[ Optional[str], OpenBBCustomParameter(description="Search query.") ] = "", provider: Optional[Literal["fmp"]] = None, **kwargs ) -> OBBject: """Search for ETFs. An empty query returns the full list of ETFs from the provider. Parameters ---------- query : Optional[str] Search query. provider : Optional[Literal['fmp']] 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) is_active : Optional[Literal[True, False]] Whether the ETF is actively trading. (provider: fmp) Returns ------- OBBject results : List[EtfSearch] Serializable results. provider : Optional[Literal['fmp']] Provider name. warnings : Optional[List[Warning_]] List of warnings. chart : Optional[Chart] Chart object. extra: Dict[str, Any] Extra info. EtfSearch --------- symbol : str Symbol representing the entity requested in the data.(ETF) name : Optional[str] Name of the ETF. market_cap : Optional[float] The market cap of the ETF. (provider: fmp) sector : Optional[str] The sector of the ETF. (provider: fmp) industry : Optional[str] The industry of the ETF. (provider: fmp) beta : Optional[float] The beta of the ETF. (provider: fmp) price : Optional[float] The current price of the ETF. (provider: fmp) last_annual_dividend : Optional[float] The last annual dividend paid. (provider: fmp) volume : Optional[float] The current trading volume of the ETF. (provider: fmp) exchange : Optional[str] The exchange code the ETF trades on. (provider: fmp) 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) Example ------- >>> from openbb import obb >>> obb.etf.search() """ # noqa: E501 return self._run( "/etf/search", **filter_inputs( provider_choices={ "provider": provider, }, standard_params={ "query": query, }, extra_params=kwargs, ) ) @validate def sectors( self, symbol: Annotated[ Union[str, List[str]], OpenBBCustomParameter(description="Symbol to get data for. (ETF)"), ], provider: Optional[Literal["fmp"]] = None, **kwargs ) -> OBBject: """ETF Sector weighting. Parameters ---------- symbol : str Symbol to get data for. (ETF) provider : Optional[Literal['fmp']] 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. Returns ------- OBBject results : List[EtfSectors] Serializable results. provider : Optional[Literal['fmp']] Provider name. warnings : Optional[List[Warning_]] List of warnings. chart : Optional[Chart] Chart object. extra: Dict[str, Any] Extra info. EtfSectors ---------- sector : str Sector of exposure. weight : Optional[float] Exposure of the ETF to the sector in normalized percentage points. Example ------- >>> from openbb import obb >>> obb.etf.sectors(symbol="AAPL") """ # noqa: E501 return self._run( "/etf/sectors", **filter_inputs( provider_choices={ "provider": provider, }, standard_params={ "symbol": ",".join(symbol) if isinstance(symbol, list) else symbol, }, extra_params=kwargs, ) )