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 | None
Reporting year of the filing. Default is the year for the most recent, reported, quarter.

quarter: int | None
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 | None
Reporting year of the filing. Default is the year for the most recent, reported, quarter.

quarter: int | None
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 | None
Reporting year of the filing. Default is the year for the most recent, reported, quarter.

quarter: int | None
Reporting quarter of the filing. Default is the most recent, reported, quarter.

use_cache: bool | None
Default: True
Whether or not to use cache for the request.

Data

• standard
• fmp
• sec

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

name: str | None
Name of the asset.

title: str | None
Title of the asset.

cusip: str | None
CUSIP of the holding.

lei: str | None
The LEI of the holding.

isin: str | None
The ISIN of the holding.

other_id: str | None
Internal identifier for the holding.

is_restricted: str | None
Whether the holding is restricted.

fair_value_level: int | None
The fair value level of the holding.

is_cash_collateral: str | None
Whether the holding is cash collateral.

is_non_cash_collateral: str | None
Whether the holding is non-cash collateral.

is_loan_by_fund: str | None
Whether the holding is loan by fund.

loan_value: float | None
The loan value of the holding.

issuer_conditional: str | None
The issuer conditions of the holding.

asset_conditional: str | None
The asset conditions of the holding.

payoff_profile: str | None
The payoff profile of the holding.

asset_category: str | None
The asset category of the holding.

issuer_category: str | None
The issuer category of the holding.

country: str | None
The country of the holding.

balance: int | float | None
The balance of the holding, in shares or units.

units: int | float | str | None
The type of units.

currency: str | None
The currency of the holding.

value: int | float | None
The value of the holding, in dollars.

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

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

name: str | None
Name of the asset.

title: str | None
Title of the asset.

cusip: str | None
CUSIP of the holding.

lei: str | None
The LEI of the holding.

isin: str | None
The ISIN of the holding.

other_id: str | None
Internal identifier for the holding.

is_restricted: str | None
Whether the holding is restricted.

fair_value_level: int | None
The fair value level of the holding.

is_cash_collateral: str | None
Whether the holding is cash collateral.

is_non_cash_collateral: str | None
Whether the holding is non-cash collateral.

is_loan_by_fund: str | None
Whether the holding is loan by fund.

loan_value: float | None
The loan value of the holding.

issuer_conditional: str | None
The issuer conditions of the holding.

asset_conditional: str | None
The asset conditions of the holding.

payoff_profile: str | None
The payoff profile of the holding.

asset_category: str | None
The asset category of the holding.

issuer_category: str | None
The issuer category of the holding.

country: str | None
The country of the holding.

balance: int | float | None
The balance of the holding, in shares or units.

units: int | float | str | None
The type of units.

currency: str | None
The currency of the holding.

value: int | float | None
The value of the holding, in dollars.

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

as_of: date | None
The acceptance datetime of the filing.

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

name: str | None
Name of the asset.

title: str | None
Title of the asset.

cusip: str | None
CUSIP of the holding.

lei: str | None
The LEI of the holding.

isin: str | None
The ISIN of the holding.

other_id: str | None
Internal identifier for the holding.

is_restricted: str | None
Whether the holding is restricted.

fair_value_level: int | None
The fair value level of the holding.

is_cash_collateral: str | None
Whether the holding is cash collateral.

is_non_cash_collateral: str | None
Whether the holding is non-cash collateral.

is_loan_by_fund: str | None
Whether the holding is loan by fund.

loan_value: float | None
The loan value of the holding.

issuer_conditional: str | None
The issuer conditions of the holding.

asset_conditional: str | None
The asset conditions of the holding.

payoff_profile: str | None
The payoff profile of the holding.

asset_category: str | None
The asset category of the holding.

issuer_category: str | None
The issuer category of the holding.

country: str | None
The country of the holding.

balance: int | float | None
The balance of the holding, in shares or units.

units: int | float | str | None
The type of units.

currency: str | None
The currency of the holding.

value: int | float | None
The value of the holding, in dollars.

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

maturity_date: date | None
The maturity date of the debt security.

coupon_kind: str | None
The type of coupon for the debt security.

rate_type: str | None
The type of rate for the debt security, floating or fixed.

annualized_return: float | None
The annualized return on the debt security.

is_default: str | None
If the debt security is defaulted.

in_arrears: str | None
If the debt security is in arrears.

is_paid_kind: str | None
If the debt security payments are paid in kind.

derivative_category: str | None
The derivative category of the holding.

counterparty: str | None
The counterparty of the derivative.

underlying_name: str | None
The name of the underlying asset associated with the derivative.

option_type: str | None
The type of option.

derivative_payoff: str | None
The payoff profile of the derivative.

expiry_date: date | None
The expiry or termination date of the derivative.

exercise_price: float | None
The exercise price of the option.

exercise_currency: str | None
The currency of the option exercise price.

shares_per_contract: float | None
The number of shares per contract.

delta: str | float | None
The delta of the option.

rate_type_rec: str | None
The type of rate for receivable portion of the swap.

receive_currency: str | None
The receive currency of the swap.

upfront_receive: float | None
The upfront amount received of the swap.

floating_rate_index_rec: str | None
The floating rate index for receivable portion of the swap.

floating_rate_spread_rec: float | None
The floating rate spread for reveivable portion of the swap.

rate_tenor_rec: str | None
The rate tenor for receivable portion of the swap.

rate_tenor_unit_rec: str | int | None
The rate tenor unit for receivable portion of the swap.

reset_date_rec: str | None
The reset date for receivable portion of the swap.

reset_date_unit_rec: str | int | None
The reset date unit for receivable portion of the swap.

rate_type_pmnt: str | None
The type of rate for payment portion of the swap.

payment_currency: str | None
The payment currency of the swap.

upfront_payment: float | None
The upfront amount received of the swap.

floating_rate_index_pmnt: str | None
The floating rate index for payment portion of the swap.

floating_rate_spread_pmnt: float | None
The floating rate spread for payment portion of the swap.

rate_tenor_pmnt: str | None
The rate tenor for payment portion of the swap.

rate_tenor_unit_pmnt: str | int | None
The rate tenor unit for payment portion of the swap.

reset_date_pmnt: str | None
The reset date for payment portion of the swap.

reset_date_unit_pmnt: str | int | None
The reset date unit for payment portion of the swap.

repo_type: str | None
The type of repo.

is_cleared: str | None
If the repo is cleared.

is_tri_party: str | None
If the repo is tri party.

principal_amount: float | None
The principal amount of the repo.

principal_currency: str | None
The currency of the principal amount.

collateral_type: str | None
The collateral type of the repo.

collateral_amount: float | None
The collateral amount of the repo.

collateral_currency: str | None
The currency of the collateral amount.

exchange_currency: str | None
The currency of the exchange rate.

exchange_rate: float | None
The exchange rate.

currency_sold: str | None
The currency sold in a Forward Derivative.

currency_amount_sold: float | None
The amount of currency sold in a Forward Derivative.

currency_bought: str | None
The currency bought in a Forward Derivative.

currency_amount_bought: float | None
The amount of currency bought in a Forward Derivative.

notional_amount: float | None
The notional amount of the derivative.

notional_currency: str | None
The currency of the derivative's notional amount.

unrealized_gain: float | None
The unrealized gain or loss on the derivative.