Files
OpenBB/website/content/platform/data_models/EtfHoldings.md
Henrique Joaquim 4400cd9a8f Merge provider and core into core (#5774)
* small changes - moving provider inside the core

* uptade readme

* lint

* remove old provider readme

* leftovers

* refactor website examples

* ruff

* fix nox

* relock

* fix fails_to_deliver headers

* fix for tests that have renamed endpoints

* fix discovery

* removed test for renamed endpoint

* fix broken syntax - test_search_financial_attributes

* fix cash/income/balance

* fix derivatives tests

* fix etf tests

* fix news tests

* fix regulators

* black

* wrong test param

* sort equity gainers/losers by percent

* platform markdown generation import

* Hotfix/fix int tests core merge (#5779)

* removing tests on old endpoint

* removing visualization on old endpoint

* fixing equity tests

* fixing examples

* fix news tests

* fix index test

* example

* add comments

* example

---------

Co-authored-by: Diogo Sousa <montezdesousa@gmail.com>

---------

Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com>
Co-authored-by: Diogo Sousa <montezdesousa@gmail.com>
Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com>
Co-authored-by: Pratyush Shukla <ps4534@nyu.edu>
2023-11-22 13:48:01 +00:00

3.3 KiB
Vendored

title, description
title description
Get the holdings for an individual ETF OpenBB Platform Data Model

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';


Implementation details

Class names

Model name Parameters class Data class
EtfHoldings EtfHoldingsQueryParams EtfHoldingsData

Import Statement

from openbb_core.provider.standard_models.etf_holdings import (
EtfHoldingsData,
EtfHoldingsQueryParams,
)

Parameters

Name Type Description Default Optional
symbol Union[str, List[str]] Symbol to get data for. (ETF) False
provider 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. fmp True
Name Type Description Default Optional
symbol Union[str, List[str]] Symbol to get data for. (ETF) False
provider 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. fmp True
date Union[str, 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. None True
cik str The CIK of the filing entity. Overrides symbol. None True

Data

Name Type Description
symbol str Symbol representing the entity requested in the data. (ETF)
name str Name of the ETF holding.
Name Type Description
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 float The balance of the holding.
units Union[str, float] The units of the holding.
currency str The currency of the holding.
value float The value of the holding in USD.
weight float The weight of the holding in ETF in %.
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.