Nport Disclosure
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
NportDisclosure | NportDisclosureQueryParams | NportDisclosureData |
Import Statement
from openbb_core.provider.standard_models.nport_disclosure import (
NportDisclosureData,
NportDisclosureQueryParams,
)
Parameters
- standard
- fmp
- sec
symbol: str
Symbol to get data for. (Fund ticker or CIK)
year: int
Reporting year of the filing. Default is the year for the most recent, reported, quarter.
quarter: int
Reporting quarter of the filing. Default is the most recent, reported, quarter.
symbol: str
Symbol to get data for. (Fund ticker or CIK)
year: int
Reporting year of the filing. Default is the year for the most recent, reported, quarter.
quarter: int
Reporting quarter of the filing. Default is the most recent, reported, quarter.
symbol: str
Symbol to get data for. (Fund ticker or CIK)
year: int
Reporting year of the filing. Default is the year for the most recent, reported, quarter.
quarter: int
Reporting quarter of the filing. Default is the most recent, reported, quarter.
use_cache: bool
Default: True
Whether or not to use cache for the request.
Data
- standard
- fmp
- sec
symbol: str
Symbol representing the entity requested in the data.
name: str
Name of the asset.
title: str
Title of the asset.
cusip: str
CUSIP of the holding.
lei: str
The LEI of the holding.
isin: str
The ISIN of the holding.
other_id: str
Internal identifier for 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.
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.
balance: Union[float, int]
The balance of the holding, in shares or units.
units: Union[int, float, str]
The type of units.
currency: str
The currency of the holding.
value: Union[float, int]
The value of the holding, in dollars.
weight: float
The weight of the holding, as a normalized percent.
symbol: str
Symbol representing the entity requested in the data.
name: str
Name of the asset.
title: str
Title of the asset.
cusip: str
CUSIP of the holding.
lei: str
The LEI of the holding.
isin: str
The ISIN of the holding.
other_id: str
Internal identifier for 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.
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.
balance: Union[float, int]
The balance of the holding, in shares or units.
units: Union[int, float, str]
The type of units.
currency: str
The currency of the holding.
value: Union[float, int]
The value of the holding, in dollars.
weight: float
The weight of the holding, as a normalized percent.
as_of: date
The acceptance datetime of the filing.
symbol: str
Symbol representing the entity requested in the data.
name: str
Name of the asset.
title: str
Title of the asset.
cusip: str
CUSIP of the holding.
lei: str
The LEI of the holding.
isin: str
The ISIN of the holding.
other_id: str
Internal identifier for 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.
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.
balance: Union[float, int]
The balance of the holding, in shares or units.
units: Union[int, float, str]
The type of units.
currency: str
The currency of the holding.
value: Union[float, int]
The value of the holding, in dollars.
weight: float
The weight of the holding, as a normalized percent.
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.