Skip to main content

Equity Ownership


Implementation details

Class names

Model nameParameters classData class
EquityOwnershipEquityOwnershipQueryParamsEquityOwnershipData

Import Statement

from openbb_core.provider.standard_models.equity_ownership import (
EquityOwnershipData,
EquityOwnershipQueryParams,
)

Parameters

NameTypeDescriptionDefaultOptional
symbolstrSymbol to get data for.False
dateUnion[date, str]A specific date to get data for.NoneTrue
pageintPage number of the data to fetch.0True
providerLiteral['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.fmpTrue

Data

NameTypeDescription
datedateThe date of the data.
cikintCentral Index Key (CIK) for the requested entity.
filing_datedateFiling date of the stock ownership.
investor_namestrInvestor name of the stock ownership.
symbolstrSymbol representing the entity requested in the data.
security_namestrSecurity name of the stock ownership.
type_of_securitystrType of security of the stock ownership.
security_cusipstrSecurity cusip of the stock ownership.
shares_typestrShares type of the stock ownership.
put_call_sharestrPut call share of the stock ownership.
investment_discretionstrInvestment discretion of the stock ownership.
industry_titlestrIndustry title of the stock ownership.
weightfloatWeight of the stock ownership.
last_weightfloatLast weight of the stock ownership.
change_in_weightfloatChange in weight of the stock ownership.
change_in_weight_percentagefloatChange in weight percentage of the stock ownership.
market_valueintMarket value of the stock ownership.
last_market_valueintLast market value of the stock ownership.
change_in_market_valueintChange in market value of the stock ownership.
change_in_market_value_percentagefloatChange in market value percentage of the stock ownership.
shares_numberintShares number of the stock ownership.
last_shares_numberintLast shares number of the stock ownership.
change_in_shares_numberfloatChange in shares number of the stock ownership.
change_in_shares_number_percentagefloatChange in shares number percentage of the stock ownership.
quarter_end_pricefloatQuarter end price of the stock ownership.
avg_price_paidfloatAverage price paid of the stock ownership.
is_newboolIs the stock ownership new.
is_sold_outboolIs the stock ownership sold out.
ownershipfloatHow much is the ownership.
last_ownershipfloatLast ownership amount.
change_in_ownershipfloatChange in ownership amount.
change_in_ownership_percentagefloatChange in ownership percentage.
holding_periodintHolding period of the stock ownership.
first_addeddateFirst added date of the stock ownership.
performancefloatPerformance of the stock ownership.
performance_percentagefloatPerformance percentage of the stock ownership.
last_performancefloatLast performance of the stock ownership.
change_in_performancefloatChange in performance of the stock ownership.
is_counted_for_performanceboolIs the stock ownership counted for performance.