holdings
Get the holdings for an individual ETF.
Examples
from openbb import obb
obb.etf.holdings(symbol='XLK', provider='fmp')
# Including a date (FMP, SEC) will return the holdings as per NPORT-P filings.
obb.etf.holdings(symbol='XLK', date=2022-03-31, provider='fmp')
# The same data can be returned from the SEC directly.
obb.etf.holdings(symbol='XLK', date=2022-03-31, provider='sec')
Parameters
- standard
- fmp
- intrinio
- sec
- tmx
symbol: str
Symbol to get data for. (ETF)
• Optional: False
symbol: str
Symbol to get data for. (ETF)
• Optional: False
date: Union[Union[date, str], str]
A specific date to get data for. Entering a date will attempt to return the NPORT-P filing for the entered date. This needs to be exactly the date of the filing. Use the holdings_date command/endpoint to find available filing dates for the ETF.
• Optional: True
cik: str
The CIK of the filing entity. Overrides symbol.
• Optional: True
symbol: str
Symbol to get data for. (ETF)
• Optional: False
date: Union[date, str]
A specific date to get data for.
• Optional: True
symbol: str
Symbol to get data for. (ETF)
• Optional: False
date: Union[Union[date, str], str]
A specific date to get data for. The date represents the period ending. The date entered will return the closest filing.
• Optional: True
use_cache: bool
Whether or not to use cache for the request.
• Default: True
• Optional: True
symbol: str
Symbol to get data for. (ETF)
• Optional: False
use_cache: bool
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.
• Default: True
• Optional: True
Returns
results: list[EtfHoldings]
Serializable results.
provider: Optional[Literal['fmp', 'intrinio', 'sec', 'tmx']]
Provider name.
warnings: Optional[list[Warning_]]
list of warnings.
chart: Optional[Chart]
Chart object.
extra: dict[str, Any]
Extra info.
Data
- standard
- fmp
- intrinio
- sec
- tmx
symbol: str
Symbol representing the entity requested in the data. (ETF)
name: str
Name of the ETF holding.
symbol: str
Symbol representing the entity requested in the data. (ETF)
name: str
Name of the ETF holding.
lei: str
The LEI of the holding.
title: str
The title of the holding.
cusip: str
The CUSIP of the holding.
isin: str
The ISIN of the holding.
balance: int
The balance of the holding, in shares or units.
units: Union[float, str]
The type of units.
currency: str
The currency of the holding.
value: float
The value of the holding, in dollars.
weight: float
The weight of the holding, as a normalized percent.
payoff_profile: str
The payoff profile of the holding.
asset_category: str
The asset category of the holding.
issuer_category: str
The issuer category of the holding.
country: str
The country of the holding.
is_restricted: str
Whether the holding is restricted.
fair_value_level: int
The fair value level of the holding.
is_cash_collateral: str
Whether the holding is cash collateral.
is_non_cash_collateral: str
Whether the holding is non-cash collateral.
is_loan_by_fund: str
Whether the holding is loan by fund.
cik: str
The CIK of the filing.
acceptance_datetime: str
The acceptance datetime of the filing.
updated: Union[date, datetime]
The date the data was updated.
symbol: str
Symbol representing the entity requested in the data. (ETF)
name: str
The common name for the holding.
security_type: str
The type of instrument for this holding. Examples(Bond='BOND', Equity='EQUI')
isin: str
The International Securities Identification Number.
ric: str
The Reuters Instrument Code.
sedol: str
The Stock Exchange Daily Official list.
share_class_figi: str
The OpenFIGI symbol for the holding.
country: str
The country or region of the holding.
maturity_date: date
The maturity date for the debt security, if available.
contract_expiry_date: date
Expiry date for the futures contract held, if available.
coupon: float
The coupon rate of the debt security, if available.
balance: Union[float, int]
The number of units of the security held, if available.
unit: str
The units of the 'balance' field.
units_per_share: float
Number of units of the security held per share outstanding of the ETF, if available.
face_value: float
The face value of the debt security, if available.
derivatives_value: float
The notional value of derivatives contracts held.
value: float
The market value of the holding, on the 'as_of' date.
weight: float
The weight of the holding, as a normalized percent.
updated: date
The 'as_of' date for the holding.
symbol: str
Symbol representing the entity requested in the data. (ETF)
name: str
Name of the ETF holding.
lei: str
The LEI of the holding.
cusip: str
The CUSIP of the holding.
isin: str
The ISIN of the holding.
other_id: str
Internal identifier for the holding.
balance: float
The balance of the holding.
weight: float
The weight of the holding in ETF in %.
value: float
The value of the holding in USD.
payoff_profile: str
The payoff profile of the holding.
units: Union[str, float]
The units of the holding.
currency: str
The currency of the holding.
asset_category: str
The asset category of the holding.
issuer_category: str
The issuer category of the holding.
country: str
The country of the holding.
is_restricted: str
Whether the holding is restricted.
fair_value_level: int
The fair value level of the holding.
is_cash_collateral: str
Whether the holding is cash collateral.
is_non_cash_collateral: str
Whether the holding is non-cash collateral.
is_loan_by_fund: str
Whether the holding is loan by fund.
loan_value: float
The loan value of the holding.
issuer_conditional: str
The issuer conditions of the holding.
asset_conditional: str
The asset conditions of the holding.
maturity_date: date
The maturity date of the debt security.
coupon_kind: str
The type of coupon for the debt security.
rate_type: str
The type of rate for the debt security, floating or fixed.
annualized_return: float
The annualized return on the debt security.
is_default: str
If the debt security is defaulted.
in_arrears: str
If the debt security is in arrears.
is_paid_kind: str
If the debt security payments are paid in kind.
derivative_category: str
The derivative category of the holding.
counterparty: str
The counterparty of the derivative.
underlying_name: str
The name of the underlying asset associated with the derivative.
option_type: str
The type of option.
derivative_payoff: str
The payoff profile of the derivative.
expiry_date: date
The expiry or termination date of the derivative.
exercise_price: float
The exercise price of the option.
exercise_currency: str
The currency of the option exercise price.
shares_per_contract: float
The number of shares per contract.
delta: Union[str, float]
The delta of the option.
rate_type_rec: str
The type of rate for receivable portion of the swap.
receive_currency: str
The receive currency of the swap.
upfront_receive: float
The upfront amount received of the swap.
floating_rate_index_rec: str
The floating rate index for receivable portion of the swap.
floating_rate_spread_rec: float
The floating rate spread for reveivable portion of the swap.
rate_tenor_rec: str
The rate tenor for receivable portion of the swap.
rate_tenor_unit_rec: Union[str, int]
The rate tenor unit for receivable portion of the swap.
reset_date_rec: str
The reset date for receivable portion of the swap.
reset_date_unit_rec: Union[str, int]
The reset date unit for receivable portion of the swap.
rate_type_pmnt: str
The type of rate for payment portion of the swap.
payment_currency: str
The payment currency of the swap.
upfront_payment: float
The upfront amount received of the swap.
floating_rate_index_pmnt: str
The floating rate index for payment portion of the swap.
floating_rate_spread_pmnt: float
The floating rate spread for payment portion of the swap.
rate_tenor_pmnt: str
The rate tenor for payment portion of the swap.
rate_tenor_unit_pmnt: Union[str, int]
The rate tenor unit for payment portion of the swap.
reset_date_pmnt: str
The reset date for payment portion of the swap.
reset_date_unit_pmnt: Union[str, int]
The reset date unit for payment portion of the swap.
repo_type: str
The type of repo.
is_cleared: str
If the repo is cleared.
is_tri_party: str
If the repo is tri party.
principal_amount: float
The principal amount of the repo.
principal_currency: str
The currency of the principal amount.
collateral_type: str
The collateral type of the repo.
collateral_amount: float
The collateral amount of the repo.
collateral_currency: str
The currency of the collateral amount.
exchange_currency: str
The currency of the exchange rate.
exchange_rate: float
The exchange rate.
currency_sold: str
The currency sold in a Forward Derivative.
currency_amount_sold: float
The amount of currency sold in a Forward Derivative.
currency_bought: str
The currency bought in a Forward Derivative.
currency_amount_bought: float
The amount of currency bought in a Forward Derivative.
notional_amount: float
The notional amount of the derivative.
notional_currency: str
The currency of the derivative's notional amount.
unrealized_gain: float
The unrealized gain or loss on the derivative.
symbol: str
The ticker symbol of the asset.
name: str
The name of the asset.
weight: float
The weight of the asset in the portfolio, as a normalized percentage.
shares: Union[str, int]
The value of the assets under management.
market_value: Union[str, float]
The market value of the holding.
currency: str
The currency of the holding.
share_percentage: float
The share percentage of the holding, as a normalized percentage.
share_change: Union[str, float]
The change in shares of the holding.
country: str
The country of the holding.
exchange: str
The exchange code of the holding.
type_id: str
The holding type ID of the asset.
fund_id: str
The fund ID of the asset.