holdings

Get the holdings for an individual ETF.

Examples

from openbb import obb
obb.etf.holdings(symbol='XLK', 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
• tmx

symbol: str
Symbol to get data for. (ETF)

symbol: str
Symbol to get data for. (ETF)

symbol: str
Symbol to get data for. (ETF)

date: date | str
A specific date to get data for.

symbol: str
Symbol to get data for. (ETF)

use_cache: bool
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.

---

Returns

results: list[EtfHoldings]

Serializable results.

provider: Optional[Literal['fmp', 'intrinio', '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
• tmx

symbol: str
Symbol representing the entity requested in the data.

name: str
Name of the asset.

symbol: str
Symbol representing the entity requested in the data.

name: str
Name of the asset.

cusip: str
The CUSIP of the holding.

isin: str
The ISIN of the holding.

weight: float
The weight of the holding, as a normalized percent.

shares: Union[float, str]
The number of shares held.

value: float
The market value of the holding.

updated: Union[date, datetime]
The date the data was updated.

symbol: str
Symbol representing the entity requested in the data.

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
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.