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
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| symbol | str | Symbol to get data for. | False | |
| date | Union[date, str] | A specific date to get data for. | None | True |
| page | int | Page number of the data to fetch. | 0 | True |
| provider | Literal['fmp'] | The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. | None | True |
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| symbol | str | Symbol to get data for. | False | |
| date | Union[date, str] | A specific date to get data for. | None | True |
| page | int | Page number of the data to fetch. | 0 | True |
| provider | Literal['fmp'] | The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp. | None | True |
Data
- standard
- fmp
| Name | Type | Description |
|---|---|---|
| date | date | The date of the data. |
| cik | int | Central Index Key (CIK) for the requested entity. |
| filing_date | date | Filing date of the stock ownership. |
| investor_name | str | Investor name of the stock ownership. |
| symbol | str | Symbol representing the entity requested in the data. |
| security_name | str | Security name of the stock ownership. |
| type_of_security | str | Type of security of the stock ownership. |
| security_cusip | str | Security cusip of the stock ownership. |
| shares_type | str | Shares type of the stock ownership. |
| put_call_share | str | Put call share of the stock ownership. |
| investment_discretion | str | Investment discretion of the stock ownership. |
| industry_title | str | Industry title of the stock ownership. |
| weight | float | Weight of the stock ownership. |
| last_weight | float | Last weight of the stock ownership. |
| change_in_weight | float | Change in weight of the stock ownership. |
| change_in_weight_percentage | float | Change in weight percentage of the stock ownership. |
| market_value | int | Market value of the stock ownership. |
| last_market_value | int | Last market value of the stock ownership. |
| change_in_market_value | int | Change in market value of the stock ownership. |
| change_in_market_value_percentage | float | Change in market value percentage of the stock ownership. |
| shares_number | int | Shares number of the stock ownership. |
| last_shares_number | int | Last shares number of the stock ownership. |
| change_in_shares_number | float | Change in shares number of the stock ownership. |
| change_in_shares_number_percentage | float | Change in shares number percentage of the stock ownership. |
| quarter_end_price | float | Quarter end price of the stock ownership. |
| avg_price_paid | float | Average price paid of the stock ownership. |
| is_new | bool | Is the stock ownership new. |
| is_sold_out | bool | Is the stock ownership sold out. |
| ownership | float | How much is the ownership. |
| last_ownership | float | Last ownership amount. |
| change_in_ownership | float | Change in ownership amount. |
| change_in_ownership_percentage | float | Change in ownership percentage. |
| holding_period | int | Holding period of the stock ownership. |
| first_added | date | First added date of the stock ownership. |
| performance | float | Performance of the stock ownership. |
| performance_percentage | float | Performance percentage of the stock ownership. |
| last_performance | float | Last performance of the stock ownership. |
| change_in_performance | float | Change in performance of the stock ownership. |
| is_counted_for_performance | bool | Is the stock ownership counted for performance. |
| Name | Type | Description |
|---|---|---|
| date | date | The date of the data. |
| cik | int | Central Index Key (CIK) for the requested entity. |
| filing_date | date | Filing date of the stock ownership. |
| investor_name | str | Investor name of the stock ownership. |
| symbol | str | Symbol representing the entity requested in the data. |
| security_name | str | Security name of the stock ownership. |
| type_of_security | str | Type of security of the stock ownership. |
| security_cusip | str | Security cusip of the stock ownership. |
| shares_type | str | Shares type of the stock ownership. |
| put_call_share | str | Put call share of the stock ownership. |
| investment_discretion | str | Investment discretion of the stock ownership. |
| industry_title | str | Industry title of the stock ownership. |
| weight | float | Weight of the stock ownership. |
| last_weight | float | Last weight of the stock ownership. |
| change_in_weight | float | Change in weight of the stock ownership. |
| change_in_weight_percentage | float | Change in weight percentage of the stock ownership. |
| market_value | int | Market value of the stock ownership. |
| last_market_value | int | Last market value of the stock ownership. |
| change_in_market_value | int | Change in market value of the stock ownership. |
| change_in_market_value_percentage | float | Change in market value percentage of the stock ownership. |
| shares_number | int | Shares number of the stock ownership. |
| last_shares_number | int | Last shares number of the stock ownership. |
| change_in_shares_number | float | Change in shares number of the stock ownership. |
| change_in_shares_number_percentage | float | Change in shares number percentage of the stock ownership. |
| quarter_end_price | float | Quarter end price of the stock ownership. |
| avg_price_paid | float | Average price paid of the stock ownership. |
| is_new | bool | Is the stock ownership new. |
| is_sold_out | bool | Is the stock ownership sold out. |
| ownership | float | How much is the ownership. |
| last_ownership | float | Last ownership amount. |
| change_in_ownership | float | Change in ownership amount. |
| change_in_ownership_percentage | float | Change in ownership percentage. |
| holding_period | int | Holding period of the stock ownership. |
| first_added | date | First added date of the stock ownership. |
| performance | float | Performance of the stock ownership. |
| performance_percentage | float | Performance percentage of the stock ownership. |
| last_performance | float | Last performance of the stock ownership. |
| change_in_performance | float | Change in performance of the stock ownership. |
| is_counted_for_performance | bool | Is the stock ownership counted for performance. |