jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-29 13:32:08 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
efd09ce75bec41ce43fa4e8aa88dbe53cd1ecc40
OpenBB/openbb_platform/openbb/package/equity_ownership.py
joshuaBri d704de554e [Feature]try to add fmp senate trading data api (#6957) 
* [Feature] Add Government Trades

* [BugFix] Supplement the missing files

* [Enhancement] Fix branch goverment_trades

* [Enhancement] Fix branch government_trades

* Capture test cassettes.

* [Enhancement] Fix branch government_trades

* some style things and prevent page from exceeding 30

* black

* linter again

* else None instead of Other

---------

Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com>
2024-12-10 16:06:04 +00:00

856 lines
37 KiB
Python
Raw Blame History

### THIS FILE IS AUTO-GENERATED. DO NOT EDIT. ###
import datetime
from typing import List, Literal, Optional, Union
from annotated_types import Ge
from openbb_core.app.model.field import OpenBBField
from openbb_core.app.model.obbject import OBBject
from openbb_core.app.static.container import Container
from openbb_core.app.static.utils.decorators import exception_handler, validate
from openbb_core.app.static.utils.filters import filter_inputs
from typing_extensions import Annotated
class ROUTER_equity_ownership(Container):
"""/equity/ownership
form_13f
government_trades
insider_trading
institutional
major_holders
share_statistics
"""
def __repr__(self) -> str:
return self.__doc__ or ""
@exception_handler
@validate
def form_13f(
self,
symbol: Annotated[
str,
OpenBBField(
description="Symbol to get data for. A CIK or Symbol can be used."
),
],
date: Annotated[
Union[datetime.date, None, str],
OpenBBField(
description="A specific date to get data for. The date represents the end of the reporting period. All form 13F-HR filings are based on the calendar year and are reported quarterly. If a date is not supplied, the most recent filing is returned. Submissions beginning 2013-06-30 are supported."
),
] = None,
limit: Annotated[
Optional[int],
OpenBBField(
description="The number of data entries to return. The number of previous filings to return. The date parameter takes priority over this parameter."
),
] = 1,
provider: Annotated[
Optional[Literal["sec"]],
OpenBBField(
description="The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec."
),
] = None,
**kwargs
) -> OBBject:
"""Get the form 13F.
The Securities and Exchange Commission's (SEC) Form 13F is a quarterly report
that is required to be filed by all institutional investment managers with at least
$100 million in assets under management.
Managers are required to file Form 13F within 45 days after the last day of the calendar quarter.
Most funds wait until the end of this period in order to conceal
their investment strategy from competitors and the public.
Parameters
----------
symbol : str
Symbol to get data for. A CIK or Symbol can be used.
date : Union[date, None, str]
A specific date to get data for. The date represents the end of the reporting period. All form 13F-HR filings are based on the calendar year and are reported quarterly. If a date is not supplied, the most recent filing is returned. Submissions beginning 2013-06-30 are supported.
limit : Optional[int]
The number of data entries to return. The number of previous filings to return. The date parameter takes priority over this parameter.
provider : Optional[Literal['sec']]
The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec.
Returns
-------
OBBject
results : List[Form13FHR]
Serializable results.
provider : Optional[Literal['sec']]
Provider name.
warnings : Optional[List[Warning_]]
List of warnings.
chart : Optional[Chart]
Chart object.
extra : Dict[str, Any]
Extra info.
Form13FHR
---------
period_ending : date
The end-of-quarter date of the filing.
issuer : str
The name of the issuer.
cusip : str
The CUSIP of the security.
asset_class : str
The title of the asset class for the security.
security_type : Optional[Literal['SH', 'PRN']]
Whether the principal amount represents the number of shares or the principal amount of such class. 'SH' for shares. 'PRN' for principal amount. Convertible debt securities are reported as 'PRN'.
option_type : Optional[Literal['call', 'put']]
Defined when the holdings being reported are put or call options. Only long positions are reported.
investment_discretion : Optional[str]
The investment discretion held by the Manager. Sole, shared-defined (DFN), or shared-other (OTR).
voting_authority_sole : Optional[int]
The number of shares for which the Manager exercises sole voting authority.
voting_authority_shared : Optional[int]
The number of shares for which the Manager exercises a defined shared voting authority.
voting_authority_none : Optional[int]
The number of shares for which the Manager exercises no voting authority.
principal_amount : int
The total number of shares of the class of security or the principal amount of such class. Defined by the 'security_type'. Only long positions are reported
value : int
The fair market value of the holding of the particular class of security. The value reported for options is the fair market value of the underlying security with respect to the number of shares controlled. Values are rounded to the nearest US dollar and use the closing price of the last trading day of the calendar year or quarter.
weight : Optional[float]
The weight of the security relative to the market value of all securities in the filing , as a normalized percent. (provider: sec)
Examples
--------
>>> from openbb import obb
>>> obb.equity.ownership.form_13f(symbol='NVDA', provider='sec')
>>> # Enter a date (calendar quarter ending) for a specific report.
>>> obb.equity.ownership.form_13f(symbol='BRK-A', date='2016-09-30', provider='sec')
>>> # Example finding Michael Burry's filings.
>>> cik = obb.regulators.sec.institutions_search("Scion Asset Management").results[0].cik
>>> # Use the `limit` parameter to return N number of reports from the most recent.
>>> obb.equity.ownership.form_13f(cik, limit=2).to_df()
""" # noqa: E501
return self._run(
"/equity/ownership/form_13f",
**filter_inputs(
provider_choices={
"provider": self._get_provider(
provider,
"equity.ownership.form_13f",
("sec",),
)
},
standard_params={
"symbol": symbol,
"date": date,
"limit": limit,
},
extra_params=kwargs,
)
)
@exception_handler
@validate
def government_trades(
self,
symbol: Annotated[
Union[str, None, List[Optional[str]]],
OpenBBField(
description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp."
),
] = None,
chamber: Annotated[
Literal["house", "senate", "all"],
OpenBBField(description="Government Chamber."),
] = "all",
limit: Annotated[
Optional[Annotated[int, Ge(ge=0)]],
OpenBBField(description="The number of data entries to return."),
] = 100,
provider: Annotated[
Optional[Literal["fmp"]],
OpenBBField(
description="The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp."
),
] = None,
**kwargs
) -> OBBject:
"""Obtain government transaction data, including data from the Senate
and the House of Representatives.
Parameters
----------
symbol : Union[str, None, List[Optional[str]]]
Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp.
chamber : Literal['house', 'senate', 'all']
Government Chamber.
limit : Optional[Annotated[int, Ge(ge=0)]]
The number of data entries to return.
provider : Optional[Literal['fmp']]
The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp.
Returns
-------
OBBject
results : List[GovernmentTrades]
Serializable results.
provider : Optional[Literal['fmp']]
Provider name.
warnings : Optional[List[Warning_]]
List of warnings.
chart : Optional[Chart]
Chart object.
extra : Dict[str, Any]
Extra info.
GovernmentTrades
----------------
symbol : Optional[str]
Symbol representing the entity requested in the data.
date : date
The date of the data.
transaction_date : Optional[date]
Date of Transaction.
representative : Optional[str]
Name of Representative.
chamber : Optional[Literal['house', 'senate']]
Government Chamber - House or Senate. (provider: fmp)
owner : Optional[str]
Ownership status (e.g., Spouse, Joint). (provider: fmp)
asset_type : Optional[str]
Type of asset involved in the transaction. (provider: fmp)
asset_description : Optional[str]
Description of the asset. (provider: fmp)
transaction_type : Optional[str]
Type of transaction (e.g., Sale, Purchase). (provider: fmp)
amount : Optional[str]
Transaction amount range. (provider: fmp)
comment : Optional[str]
Additional comments on the transaction. (provider: fmp)
url : Optional[str]
Link to the transaction document. (provider: fmp)
Examples
--------
>>> from openbb import obb
>>> obb.equity.ownership.government_trades(symbol='AAPL', chamber='all', provider='fmp')
>>> obb.equity.ownership.government_trades(limit=500, chamber='all', provider='fmp')
""" # noqa: E501
return self._run(
"/equity/ownership/government_trades",
**filter_inputs(
provider_choices={
"provider": self._get_provider(
provider,
"equity.ownership.government_trades",
("fmp",),
)
},
standard_params={
"symbol": symbol,
"chamber": chamber,
"limit": limit,
},
extra_params=kwargs,
info={
"symbol": {"fmp": {"multiple_items_allowed": True, "choices": None}}
},
)
)
@exception_handler
@validate
def insider_trading(
self,
symbol: Annotated[str, OpenBBField(description="Symbol to get data for.")],
limit: Annotated[
int, OpenBBField(description="The number of data entries to return.")
] = 500,
provider: Annotated[
Optional[Literal["fmp", "intrinio", "sec"]],
OpenBBField(
description="The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio, sec."
),
] = None,
**kwargs
) -> OBBject:
"""Get data about trading by a company's management team and board of directors.
Parameters
----------
symbol : str
Symbol to get data for.
limit : int
The number of data entries to return.
provider : Optional[Literal['fmp', 'intrinio', 'sec']]
The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio, sec.
transaction_type : Optional[Literal['award', 'conversion', 'return', 'expire_short', 'in_kind', 'gift', 'expire_long', 'discretionary', 'other', 'small', 'exempt', 'otm', 'purchase', 'sale', 'tender', 'will', 'itm', 'trust']]
Type of the transaction. (provider: fmp)
start_date : Optional[datetime.date]
Start date of the data, in YYYY-MM-DD format. (provider: intrinio);
Start date of the data, in YYYY-MM-DD format. Wide date ranges can result in long download times. Recommended to use a smaller date range, default is 120 days ago. (provider: sec)
end_date : Optional[datetime.date]
End date of the data, in YYYY-MM-DD format. (provider: intrinio, sec)
ownership_type : Optional[Literal['D', 'I']]
Type of ownership. (provider: intrinio)
sort_by : Optional[Literal['filing_date', 'updated_on']]
Field to sort by. (provider: intrinio)
use_cache : bool
Persist the data locally for future use. Default is True. Each form submission is an individual download and the SEC limits the number of concurrent downloads. This prevents the same file from being downloaded multiple times. (provider: sec)
Returns
-------
OBBject
results : List[InsiderTrading]
Serializable results.
provider : Optional[Literal['fmp', 'intrinio', 'sec']]
Provider name.
warnings : Optional[List[Warning_]]
List of warnings.
chart : Optional[Chart]
Chart object.
extra : Dict[str, Any]
Extra info.
InsiderTrading
--------------
symbol : Optional[str]
Symbol representing the entity requested in the data.
company_cik : Optional[Union[int, str]]
CIK number of the company.
filing_date : Optional[Union[date, datetime]]
Filing date of the trade.
transaction_date : Optional[date]
Date of the transaction.
owner_cik : Optional[Union[int, str]]
Reporting individual's CIK.
owner_name : Optional[str]
Name of the reporting individual.
owner_title : Optional[str]
The title held by the reporting individual.
transaction_type : Optional[str]
Type of transaction being reported.
acquisition_or_disposition : Optional[str]
Acquisition or disposition of the shares.
security_type : Optional[str]
The type of security transacted.
securities_owned : Optional[float]
Number of securities owned by the reporting individual.
securities_transacted : Optional[float]
Number of securities transacted by the reporting individual.
transaction_price : Optional[float]
The price of the transaction.
filing_url : Optional[str]
Link to the filing.
form_type : Optional[str]
Form type of the insider trading. (provider: fmp)
company_name : Optional[str]
Name of the company. (provider: intrinio, sec)
conversion_exercise_price : Optional[float]
Conversion/Exercise price of the shares. (provider: intrinio);
Price of conversion or exercise of the securities. (provider: sec)
deemed_execution_date : Optional[date]
Deemed execution date of the trade. (provider: intrinio);
Deemed execution date. (provider: sec)
exercise_date : Optional[date]
Exercise date of the trade. (provider: intrinio);
Date of exercise. (provider: sec)
expiration_date : Optional[date]
Expiration date of the derivative. (provider: intrinio);
Date of expiration for the derivative. (provider: sec)
underlying_security_title : Optional[str]
Name of the underlying non-derivative security related to this derivative transaction. (provider: intrinio);
Title of the underlying security. (provider: sec)
underlying_shares : Optional[Union[int, float]]
Number of underlying shares related to this derivative transaction. (provider: intrinio)
nature_of_ownership : Optional[str]
Nature of ownership of the insider trading. (provider: intrinio);
Nature of the ownership. (provider: sec)
director : Optional[bool]
Whether the owner is a director. (provider: intrinio, sec)
officer : Optional[bool]
Whether the owner is an officer. (provider: intrinio, sec)
ten_percent_owner : Optional[bool]
Whether the owner is a 10% owner. (provider: intrinio, sec)
other_relation : Optional[bool]
Whether the owner is having another relation. (provider: intrinio)
derivative_transaction : Optional[bool]
Whether the owner is having a derivative transaction. (provider: intrinio)
report_line_number : Optional[int]
Report line number of the insider trading. (provider: intrinio)
form : Optional[Union[int, str]]
Form type. (provider: sec)
other : Optional[bool]
Whether the owner is classified as other. (provider: sec)
other_text : Optional[str]
Text for other classification. (provider: sec)
transaction_timeliness : Optional[str]
Timeliness of the transaction. (provider: sec)
ownership_type : Optional[str]
Type of ownership, direct or indirect. (provider: sec)
underlying_security_shares : Optional[float]
Number of underlying shares associated with the derivative. (provider: sec)
underlying_security_value : Optional[float]
Value of the underlying security. (provider: sec)
transaction_value : Optional[float]
Total value of the transaction. (provider: sec)
value_owned : Optional[float]
Value of the securities owned after the transaction. (provider: sec)
footnote : Optional[str]
Footnote for the transaction. (provider: sec)
Examples
--------
>>> from openbb import obb
>>> obb.equity.ownership.insider_trading(symbol='AAPL', provider='fmp')
>>> obb.equity.ownership.insider_trading(symbol='AAPL', limit=500, provider='intrinio')
""" # noqa: E501
return self._run(
"/equity/ownership/insider_trading",
**filter_inputs(
provider_choices={
"provider": self._get_provider(
provider,
"equity.ownership.insider_trading",
("fmp", "intrinio", "sec"),
)
},
standard_params={
"symbol": symbol,
"limit": limit,
},
extra_params=kwargs,
info={
"transaction_type": {
"fmp": {
"multiple_items_allowed": False,
"choices": [
"award",
"conversion",
"return",
"expire_short",
"in_kind",
"gift",
"expire_long",
"discretionary",
"other",
"small",
"exempt",
"otm",
"purchase",
"sale",
"tender",
"will",
"itm",
"trust",
],
}
}
},
)
)
@exception_handler
@validate
def institutional(
self,
symbol: Annotated[str, OpenBBField(description="Symbol to get data for.")],
provider: Annotated[
Optional[Literal["fmp"]],
OpenBBField(
description="The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp."
),
] = None,
**kwargs
) -> OBBject:
"""Get data about institutional ownership for a given company over time.
Parameters
----------
symbol : str
Symbol to get data for.
provider : Optional[Literal['fmp']]
The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp.
include_current_quarter : Optional[bool]
Include current quarter data. (provider: fmp)
date : Optional[datetime.date]
A specific date to get data for. (provider: fmp)
Returns
-------
OBBject
results : List[InstitutionalOwnership]
Serializable results.
provider : Optional[Literal['fmp']]
Provider name.
warnings : Optional[List[Warning_]]
List of warnings.
chart : Optional[Chart]
Chart object.
extra : Dict[str, Any]
Extra info.
InstitutionalOwnership
----------------------
symbol : str
Symbol representing the entity requested in the data.
cik : Optional[str]
Central Index Key (CIK) for the requested entity.
date : date
The date of the data.
investors_holding : Optional[int]
Number of investors holding the stock. (provider: fmp)
last_investors_holding : Optional[int]
Number of investors holding the stock in the last quarter. (provider: fmp)
investors_holding_change : Optional[int]
Change in the number of investors holding the stock. (provider: fmp)
number_of_13f_shares : Optional[int]
Number of 13F shares. (provider: fmp)
last_number_of_13f_shares : Optional[int]
Number of 13F shares in the last quarter. (provider: fmp)
number_of_13f_shares_change : Optional[int]
Change in the number of 13F shares. (provider: fmp)
total_invested : Optional[float]
Total amount invested. (provider: fmp)
last_total_invested : Optional[float]
Total amount invested in the last quarter. (provider: fmp)
total_invested_change : Optional[float]
Change in the total amount invested. (provider: fmp)
ownership_percent : Optional[float]
Ownership percent. (provider: fmp)
last_ownership_percent : Optional[float]
Ownership percent in the last quarter. (provider: fmp)
ownership_percent_change : Optional[float]
Change in the ownership percent. (provider: fmp)
new_positions : Optional[int]
Number of new positions. (provider: fmp)
last_new_positions : Optional[int]
Number of new positions in the last quarter. (provider: fmp)
new_positions_change : Optional[int]
Change in the number of new positions. (provider: fmp)
increased_positions : Optional[int]
Number of increased positions. (provider: fmp)
last_increased_positions : Optional[int]
Number of increased positions in the last quarter. (provider: fmp)
increased_positions_change : Optional[int]
Change in the number of increased positions. (provider: fmp)
closed_positions : Optional[int]
Number of closed positions. (provider: fmp)
last_closed_positions : Optional[int]
Number of closed positions in the last quarter. (provider: fmp)
closed_positions_change : Optional[int]
Change in the number of closed positions. (provider: fmp)
reduced_positions : Optional[int]
Number of reduced positions. (provider: fmp)
last_reduced_positions : Optional[int]
Number of reduced positions in the last quarter. (provider: fmp)
reduced_positions_change : Optional[int]
Change in the number of reduced positions. (provider: fmp)
total_calls : Optional[int]
Total number of call options contracts traded for Apple Inc. on the specified date. (provider: fmp)
last_total_calls : Optional[int]
Total number of call options contracts traded for Apple Inc. on the previous reporting date. (provider: fmp)
total_calls_change : Optional[int]
Change in the total number of call options contracts traded between the current and previous reporting dates. (provider: fmp)
total_puts : Optional[int]
Total number of put options contracts traded for Apple Inc. on the specified date. (provider: fmp)
last_total_puts : Optional[int]
Total number of put options contracts traded for Apple Inc. on the previous reporting date. (provider: fmp)
total_puts_change : Optional[int]
Change in the total number of put options contracts traded between the current and previous reporting dates. (provider: fmp)
put_call_ratio : Optional[float]
Put-call ratio, which is the ratio of the total number of put options to call options traded on the specified date. (provider: fmp)
last_put_call_ratio : Optional[float]
Put-call ratio on the previous reporting date. (provider: fmp)
put_call_ratio_change : Optional[float]
Change in the put-call ratio between the current and previous reporting dates. (provider: fmp)
Examples
--------
>>> from openbb import obb
>>> obb.equity.ownership.institutional(symbol='AAPL', provider='fmp')
""" # noqa: E501
return self._run(
"/equity/ownership/institutional",
**filter_inputs(
provider_choices={
"provider": self._get_provider(
provider,
"equity.ownership.institutional",
("fmp",),
)
},
standard_params={
"symbol": symbol,
},
extra_params=kwargs,
)
)
@exception_handler
@validate
def major_holders(
self,
symbol: Annotated[str, OpenBBField(description="Symbol to get data for.")],
date: Annotated[
Union[datetime.date, None, str],
OpenBBField(description="A specific date to get data for."),
] = None,
page: Annotated[
Optional[int], OpenBBField(description="Page number of the data to fetch.")
] = 0,
provider: Annotated[
Optional[Literal["fmp"]],
OpenBBField(
description="The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp."
),
] = None,
**kwargs
) -> OBBject:
"""Get data about major holders for a given company over time.
Parameters
----------
symbol : str
Symbol to get data for.
date : Union[date, None, str]
A specific date to get data for.
page : Optional[int]
Page number of the data to fetch.
provider : Optional[Literal['fmp']]
The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp.
Returns
-------
OBBject
results : List[EquityOwnership]
Serializable results.
provider : Optional[Literal['fmp']]
Provider name.
warnings : Optional[List[Warning_]]
List of warnings.
chart : Optional[Chart]
Chart object.
extra : Dict[str, Any]
Extra info.
EquityOwnership
---------------
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.
Examples
--------
>>> from openbb import obb
>>> obb.equity.ownership.major_holders(symbol='AAPL', provider='fmp')
>>> obb.equity.ownership.major_holders(symbol='AAPL', page=0, provider='fmp')
""" # noqa: E501
return self._run(
"/equity/ownership/major_holders",
**filter_inputs(
provider_choices={
"provider": self._get_provider(
provider,
"equity.ownership.major_holders",
("fmp",),
)
},
standard_params={
"symbol": symbol,
"date": date,
"page": page,
},
extra_params=kwargs,
)
)
@exception_handler
@validate
def share_statistics(
self,
symbol: Annotated[
Union[str, List[str]],
OpenBBField(
description="Symbol to get data for. Multiple comma separated items allowed for provider(s): yfinance."
),
],
provider: Annotated[
Optional[Literal["fmp", "intrinio", "yfinance"]],
OpenBBField(
description="The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio, yfinance."
),
] = None,
**kwargs
) -> OBBject:
"""Get data about share float for a given company.
Parameters
----------
symbol : Union[str, List[str]]
Symbol to get data for. Multiple comma separated items allowed for provider(s): yfinance.
provider : Optional[Literal['fmp', 'intrinio', 'yfinance']]
The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio, yfinance.
Returns
-------
OBBject
results : List[ShareStatistics]
Serializable results.
provider : Optional[Literal['fmp', 'intrinio', 'yfinance']]
Provider name.
warnings : Optional[List[Warning_]]
List of warnings.
chart : Optional[Chart]
Chart object.
extra : Dict[str, Any]
Extra info.
ShareStatistics
---------------
symbol : str
Symbol representing the entity requested in the data.
date : Optional[date]
The date of the data.
free_float : Optional[float]
Percentage of unrestricted shares of a publicly-traded company.
float_shares : Optional[float]
Number of shares available for trading by the general public.
outstanding_shares : Optional[float]
Total number of shares of a publicly-traded company.
source : Optional[str]
Source of the received data.
adjusted_outstanding_shares : Optional[float]
Total number of shares of a publicly-traded company, adjusted for splits. (provider: intrinio)
public_float : Optional[float]
Aggregate market value of the shares of a publicly-traded company. (provider: intrinio)
implied_shares_outstanding : Optional[int]
Implied Shares Outstanding of common equity, assuming the conversion of all convertible subsidiary equity into common. (provider: yfinance)
short_interest : Optional[int]
Number of shares that are reported short. (provider: yfinance)
short_percent_of_float : Optional[float]
Percentage of shares that are reported short, as a normalized percent. (provider: yfinance)
days_to_cover : Optional[float]
Number of days to repurchase the shares as a ratio of average daily volume (provider: yfinance)
short_interest_prev_month : Optional[int]
Number of shares that were reported short in the previous month. (provider: yfinance)
short_interest_prev_date : Optional[date]
Date of the previous month's report. (provider: yfinance)
insider_ownership : Optional[float]
Percentage of shares held by insiders, as a normalized percent. (provider: yfinance)
institution_ownership : Optional[float]
Percentage of shares held by institutions, as a normalized percent. (provider: yfinance)
institution_float_ownership : Optional[float]
Percentage of float held by institutions, as a normalized percent. (provider: yfinance)
institutions_count : Optional[int]
Number of institutions holding shares. (provider: yfinance)
Examples
--------
>>> from openbb import obb
>>> obb.equity.ownership.share_statistics(symbol='AAPL', provider='fmp')
""" # noqa: E501
return self._run(
"/equity/ownership/share_statistics",
**filter_inputs(
provider_choices={
"provider": self._get_provider(
provider,
"equity.ownership.share_statistics",
("fmp", "intrinio", "yfinance"),
)
},
standard_params={
"symbol": symbol,
},
extra_params=kwargs,
info={
"symbol": {
"yfinance": {"multiple_items_allowed": True, "choices": None}
}
},
)
)
Reference in New Issue View Git Blame Copy Permalink