Equity Ownership
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
EquityOwnership | EquityOwnershipQueryParams | EquityOwnershipData |
Import Statement
from openbb_core.provider.standard_models.equity_ownership import (
EquityOwnershipData,
EquityOwnershipQueryParams,
)
Parameters
- standard
- fmp
symbol: str
Symbol to get data for.
symbol: str
Symbol to get data for.
year: int | None
Calendar year for the data. If not provided, the latest year is used.
quarter: int | None
Calendar quarter for the data. Valid values are 1, 2, 3, or 4. If not provided, the quarter previous to the current quarter is used.
page: int | None
Page number, used in conjunction with the limit. The default is 0.
limit: int | None
Number of items to return per page. The default is 100, which is the maximum.
Data
- standard
- fmp
investor_name: str
Investing entity's name.
cik: str | None
Central Index Key (CIK) for the requested entity.
date: date | str
The date of the data. For the period ending.
filing_date: date | None
Date when reported.
symbol: str
Symbol representing the entity requested in the data.
investor_name: str
Investing entity's name.
cik: str | None
Central Index Key (CIK) for the requested entity.
date: date | str
The date of the data. For the period ending.
filing_date: date | None
Date when reported.
symbol: str
Symbol representing the entity requested in the data.
security_name: str
Security name.
security_type: str
Type or class of security.
security_cusip: str
CUSIP of the security.
shares_type: str
Shares type.
put_call_share: str
Whether the share represents a put, call, or share.
investment_discretion: str
Investment discretion of reporting entity.
sic_industry: str
SIC classification industry.
weight: float
Weight relative to the total reported portfolio.
weight_previous: float
Weight from the previous quarter.
weight_change: float
Change in the weight from the previous quarter.
weight_change_percent: float
Change in weight as a percent.
market_value: int
Market value of the stock ownership.
market_value_previous: int
Market value from the previous quarter.
market_value_change: int
Change in market value from the previous quarter.
market_value_change_percent: float
Change in market value from the previous quarter, as a percent.
shares_number: int
Number of controlled shares.
shares_previous: int
Number of controlled shares from the previous quarter.
shares_change: float
Change in shares number from the previous quarter.
shares_change_percent: float
Change in shares number from the previous quarter, as a percent.
quarter_end_price: float
Market price of the security at the end of the quarter.
avg_price_paid: float
Average price paid for the shares.
is_new: bool
If the security was newly added this quarter.
is_sold_out: bool
If the security was sold out this quarter.
ownership: float | None
Ownership stake in the security, as a percent.
ownership_previous: float | None
Ownership stake in the security from the previous quarter, as a percent.
ownership_change: float | None
Change in ownership stake from the previous quarter.
ownership_change_percent: float | None
Change in ownership stake from the previous quarter, as a percent.
holding_period: int
Holding period of the security.
first_added: date
When the security was first reported as held.
performance: float | None
Performance value of the security holding.
performance_percent: float | None
Performance of the security holding, as a percent.
performance_previous: float | None
Performance value of the security holding from the previous quarter.
performance_change: float | None
Change in value of the security holding's performance.
is_counted_for_performance: bool
If the security is counted for the performance measurement.