jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-27 04:31:13 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
8a30a44555d97132f6bddcbc4a4facdd97ecc591
OpenBB/openbb_platform/openbb/package/stocks_fa.py
Diogo Sousa 8a30a44555 avoid name collision with validator
2023-10-12 13:36:14 +01:00

3175 lines
113 KiB
Python
Raw Blame History

### THIS FILE IS AUTO-GENERATED. DO NOT EDIT. ###
import datetime
from typing import List, Literal, Optional, Union
from openbb_core.app.model.custom_parameter import OpenBBCustomParameter
from openbb_core.app.model.obbject import OBBject
from openbb_core.app.static.container import Container
from openbb_core.app.static.decorators import validate as _validate
from openbb_core.app.static.filters import filter_inputs
from openbb_provider.abstract.data import Data
from typing_extensions import Annotated
class ROUTER_stocks_fa(Container):
"""/stocks/fa
balance
balance_growth
cal
cash
cash_growth
comp
comsplit
divs
earning
emp
est
filings
income
income_growth
ins
ins_own
metrics
mgmt
overview
own
pt
pta
ratios
revgeo
revseg
shrs
split
transcript
"""
def __repr__(self) -> str:
return self.__doc__ or ""
@_validate
def balance(
self,
symbol: Annotated[
Union[str, List[str]],
OpenBBCustomParameter(description="Symbol to get data for."),
],
period: Annotated[
Literal["annual", "quarter"],
OpenBBCustomParameter(description="Period of the data to return."),
] = "annual",
limit: Annotated[
int,
OpenBBCustomParameter(description="The number of data entries to return."),
] = 12,
provider: Optional[Literal["fmp", "intrinio", "polygon"]] = None,
**kwargs
) -> OBBject[List[Data]]:
"""Balance Sheet.
Parameters
----------
symbol : str
Symbol to get data for.
period : Literal['annual', 'quarter']
Period of the data to return.
limit : int
The number of data entries to return.
provider : Optional[Literal['fmp', 'intrinio', 'polygon']]
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.
cik : Optional[str]
Central Index Key (CIK) of the company. (provider: fmp)
type : Literal['reported', 'standardized']
Type of the statement to be fetched. (provider: intrinio)
year : Optional[int]
Year of the statement to be fetched. (provider: intrinio)
company_name : Optional[str]
Name of the company. (provider: polygon)
company_name_search : Optional[str]
Name of the company to search. (provider: polygon)
sic : Optional[str]
The Standard Industrial Classification (SIC) of the company. (provider: polygon)
filing_date : Optional[datetime.date]
Filing date of the financial statement. (provider: polygon)
filing_date_lt : Optional[datetime.date]
Filing date less than the given date. (provider: polygon)
filing_date_lte : Optional[datetime.date]
Filing date less than or equal to the given date. (provider: polygon)
filing_date_gt : Optional[datetime.date]
Filing date greater than the given date. (provider: polygon)
filing_date_gte : Optional[datetime.date]
Filing date greater than or equal to the given date. (provider: polygon)
period_of_report_date : Optional[datetime.date]
Period of report date of the financial statement. (provider: polygon)
period_of_report_date_lt : Optional[datetime.date]
Period of report date less than the given date. (provider: polygon)
period_of_report_date_lte : Optional[datetime.date]
Period of report date less than or equal to the given date. (provider: polygon)
period_of_report_date_gt : Optional[datetime.date]
Period of report date greater than the given date. (provider: polygon)
period_of_report_date_gte : Optional[datetime.date]
Period of report date greater than or equal to the given date. (provider: polygon)
include_sources : Optional[bool]
Whether to include the sources of the financial statement. (provider: polygon)
order : Optional[Literal['asc', 'desc']]
Order of the financial statement. (provider: polygon)
sort : Optional[Literal['filing_date', 'period_of_report_date']]
Sort of the financial statement. (provider: polygon)
Returns
-------
OBBject
results : List[BalanceSheet]
Serializable results.
provider : Optional[Literal['fmp', 'intrinio', 'polygon']]
Provider name.
warnings : Optional[List[Warning_]]
List of warnings.
chart : Optional[Chart]
Chart object.
extra: Dict[str, Any]
Extra info.
BalanceSheet
------------
symbol : Optional[str]
Symbol to get data for.
date : date
Date of the fetched statement.
cik : Optional[str]
Central Index Key (CIK) of the company.
currency : Optional[str]
Reporting currency.
filling_date : Optional[date]
Filling date.
accepted_date : Optional[datetime]
Accepted date.
period : Optional[str]
Reporting period of the statement.
cash_and_cash_equivalents : Optional[int]
Cash and cash equivalents
short_term_investments : Optional[int]
Short-term investments
long_term_investments : Optional[int]
Long-term investments
inventory : Optional[int]
Inventory
net_receivables : Optional[int]
Receivables, net
marketable_securities : Optional[int]
Marketable securities
property_plant_equipment_net : Optional[int]
Property, plant and equipment, net
goodwill : Optional[int]
Goodwill
assets : Optional[int]
Total assets
current_assets : Optional[int]
Total current assets
other_current_assets : Optional[int]
Other current assets
intangible_assets : Optional[int]
Intangible assets
tax_assets : Optional[int]
Accrued income taxes
other_assets : Optional[int]
Other assets
non_current_assets : Optional[int]
Total non-current assets
other_non_current_assets : Optional[int]
Other non-current assets
account_payables : Optional[int]
Accounts payable
tax_payables : Optional[int]
Accrued income taxes
deferred_revenue : Optional[int]
Accrued income taxes, other deferred revenue
total_assets : Optional[int]
Total assets
long_term_debt : Optional[int]
Long-term debt, Operating lease obligations, Long-term finance lease obligations
short_term_debt : Optional[int]
Short-term borrowings, Long-term debt due within one year, Operating lease obligations due within one year, Finance lease obligations due within one year
liabilities : Optional[int]
Total liabilities
other_current_liabilities : Optional[int]
Other current liabilities
current_liabilities : Optional[int]
Total current liabilities
total_liabilities_and_total_equity : Optional[int]
Total liabilities and total equity
other_liabilities : Optional[int]
Other liabilities
other_non_current_liabilities : Optional[int]
Other non-current liabilities
non_current_liabilities : Optional[int]
Total non-current liabilities
total_liabilities_and_stockholders_equity : Optional[int]
Total liabilities and stockholders' equity
other_stockholder_equity : Optional[int]
Other stockholders equity
total_stockholders_equity : Optional[int]
Total stockholders' equity
total_liabilities : Optional[int]
Total liabilities
common_stock : Optional[int]
Common stock
preferred_stock : Optional[int]
Preferred stock
accumulated_other_comprehensive_income_loss : Optional[int]
Accumulated other comprehensive income (loss)
retained_earnings : Optional[int]
Retained earnings
minority_interest : Optional[int]
Minority interest
total_equity : Optional[int]
Total equity
calendar_year : Optional[int]
Calendar Year (provider: fmp)
cash_and_short_term_investments : Optional[int]
Cash and Short Term Investments (provider: fmp)
goodwill_and_intangible_assets : Optional[int]
Goodwill and Intangible Assets (provider: fmp)
deferred_revenue_non_current : Optional[int]
Deferred Revenue Non Current (provider: fmp)
total_investments : Optional[int]
Total investments (provider: fmp)
capital_lease_obligations : Optional[int]
Capital lease obligations (provider: fmp)
deferred_tax_liabilities_non_current : Optional[int]
Deferred Tax Liabilities Non Current (provider: fmp)
total_debt : Optional[int]
Total Debt (provider: fmp)
net_debt : Optional[int]
Net Debt (provider: fmp)
link : Optional[str]
Link to the statement. (provider: fmp)
final_link : Optional[str]
Link to the final statement. (provider: fmp)""" # noqa: E501
inputs = filter_inputs(
provider_choices={
"provider": provider,
},
standard_params={
"symbol": ",".join(symbol) if isinstance(symbol, list) else symbol,
"period": period,
"limit": limit,
},
extra_params=kwargs,
)
return self._run(
"/stocks/fa/balance",
**inputs,
)
@_validate
def balance_growth(
self,
symbol: Annotated[
Union[str, List[str]],
OpenBBCustomParameter(description="Symbol to get data for."),
],
limit: Annotated[
int,
OpenBBCustomParameter(description="The number of data entries to return."),
] = 10,
provider: Optional[Literal["fmp"]] = None,
**kwargs
) -> OBBject[List[Data]]:
"""Balance Sheet Statement Growth.
Parameters
----------
symbol : str
Symbol to get data for.
limit : int
The number of data entries to return.
provider : Optional[Literal['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.
Returns
-------
OBBject
results : List[BalanceSheetGrowth]
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.
BalanceSheetGrowth
------------------
symbol : Optional[str]
Symbol to get data for.
date : date
The date of the data.
period : str
Reporting period.
growth_cash_and_cash_equivalents : float
Growth rate of cash and cash equivalents.
growth_short_term_investments : float
Growth rate of short-term investments.
growth_cash_and_short_term_investments : float
Growth rate of cash and short-term investments.
growth_net_receivables : float
Growth rate of net receivables.
growth_inventory : float
Growth rate of inventory.
growth_other_current_assets : float
Growth rate of other current assets.
growth_total_current_assets : float
Growth rate of total current assets.
growth_property_plant_equipment_net : float
Growth rate of net property, plant, and equipment.
growth_goodwill : float
Growth rate of goodwill.
growth_intangible_assets : float
Growth rate of intangible assets.
growth_goodwill_and_intangible_assets : float
Growth rate of goodwill and intangible assets.
growth_long_term_investments : float
Growth rate of long-term investments.
growth_tax_assets : float
Growth rate of tax assets.
growth_other_non_current_assets : float
Growth rate of other non-current assets.
growth_total_non_current_assets : float
Growth rate of total non-current assets.
growth_other_assets : float
Growth rate of other assets.
growth_total_assets : float
Growth rate of total assets.
growth_account_payables : float
Growth rate of accounts payable.
growth_short_term_debt : float
Growth rate of short-term debt.
growth_tax_payables : float
Growth rate of tax payables.
growth_deferred_revenue : float
Growth rate of deferred revenue.
growth_other_current_liabilities : float
Growth rate of other current liabilities.
growth_total_current_liabilities : float
Growth rate of total current liabilities.
growth_long_term_debt : float
Growth rate of long-term debt.
growth_deferred_revenue_non_current : float
Growth rate of non-current deferred revenue.
growth_deferrred_tax_liabilities_non_current : float
Growth rate of non-current deferred tax liabilities.
growth_other_non_current_liabilities : float
Growth rate of other non-current liabilities.
growth_total_non_current_liabilities : float
Growth rate of total non-current liabilities.
growth_other_liabilities : float
Growth rate of other liabilities.
growth_total_liabilities : float
Growth rate of total liabilities.
growth_common_stock : float
Growth rate of common stock.
growth_retained_earnings : float
Growth rate of retained earnings.
growth_accumulated_other_comprehensive_income_loss : float
Growth rate of accumulated other comprehensive income/loss.
growth_othertotal_stockholders_equity : float
Growth rate of other total stockholders' equity.
growth_total_stockholders_equity : float
Growth rate of total stockholders' equity.
growth_total_liabilities_and_stockholders_equity : float
Growth rate of total liabilities and stockholders' equity.
growth_total_investments : float
Growth rate of total investments.
growth_total_debt : float
Growth rate of total debt.
growth_net_debt : float
Growth rate of net debt.""" # noqa: E501
inputs = filter_inputs(
provider_choices={
"provider": provider,
},
standard_params={
"symbol": ",".join(symbol) if isinstance(symbol, list) else symbol,
"limit": limit,
},
extra_params=kwargs,
)
return self._run(
"/stocks/fa/balance_growth",
**inputs,
)
@_validate
def cal(
self,
start_date: Annotated[
Union[datetime.date, str],
OpenBBCustomParameter(
description="Start date of the data, in YYYY-MM-DD format."
),
] = None,
end_date: Annotated[
Union[datetime.date, str],
OpenBBCustomParameter(
description="End date of the data, in YYYY-MM-DD format."
),
] = None,
provider: Optional[Literal["fmp"]] = None,
**kwargs
) -> OBBject[List[Data]]:
"""Show Dividend Calendar for a given start and end dates.
Parameters
----------
start_date : date
Start date of the data, in YYYY-MM-DD format.
end_date : date
End date of the data, in YYYY-MM-DD format.
provider : Optional[Literal['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.
Returns
-------
OBBject
results : List[DividendCalendar]
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.
DividendCalendar
----------------
symbol : str
Symbol to get data for.
date : date
The date of the data.
label : str
Date in human readable form in the calendar.
adj_dividend : Optional[float]
Adjusted dividend on a date in the calendar.
dividend : Optional[float]
Dividend amount in the calendar.
record_date : Optional[date]
Record date of the dividend in the calendar.
payment_date : Optional[date]
Payment date of the dividend in the calendar.
declaration_date : Optional[date]
Declaration date of the dividend in the calendar.""" # noqa: E501
inputs = filter_inputs(
provider_choices={
"provider": provider,
},
standard_params={
"start_date": start_date,
"end_date": end_date,
},
extra_params=kwargs,
)
return self._run(
"/stocks/fa/cal",
**inputs,
)
@_validate
def cash(
self,
symbol: Annotated[
Union[str, List[str]],
OpenBBCustomParameter(description="Symbol to get data for."),
],
period: Annotated[
Literal["annual", "quarter"],
OpenBBCustomParameter(description="Period of the data to return."),
] = "annual",
limit: Annotated[
int,
OpenBBCustomParameter(description="The number of data entries to return."),
] = 12,
provider: Optional[Literal["fmp", "intrinio", "polygon"]] = None,
**kwargs
) -> OBBject[List[Data]]:
"""Cash Flow Statement.
Parameters
----------
symbol : str
Symbol to get data for.
period : Literal['annual', 'quarter']
Period of the data to return.
limit : int
The number of data entries to return.
provider : Optional[Literal['fmp', 'intrinio', 'polygon']]
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.
cik : Optional[str]
Central Index Key (CIK) of the company. (provider: fmp)
type : Literal['reported', 'standardized']
Type of the statement to be fetched. (provider: intrinio)
year : Optional[int]
Year of the statement to be fetched. (provider: intrinio)
company_name : Optional[str]
Name of the company. (provider: polygon)
company_name_search : Optional[str]
Name of the company to search. (provider: polygon)
sic : Optional[str]
The Standard Industrial Classification (SIC) of the company. (provider: polygon)
filing_date : Optional[datetime.date]
Filing date of the financial statement. (provider: polygon)
filing_date_lt : Optional[datetime.date]
Filing date less than the given date. (provider: polygon)
filing_date_lte : Optional[datetime.date]
Filing date less than or equal to the given date. (provider: polygon)
filing_date_gt : Optional[datetime.date]
Filing date greater than the given date. (provider: polygon)
filing_date_gte : Optional[datetime.date]
Filing date greater than or equal to the given date. (provider: polygon)
period_of_report_date : Optional[datetime.date]
Period of report date of the financial statement. (provider: polygon)
period_of_report_date_lt : Optional[datetime.date]
Period of report date less than the given date. (provider: polygon)
period_of_report_date_lte : Optional[datetime.date]
Period of report date less than or equal to the given date. (provider: polygon)
period_of_report_date_gt : Optional[datetime.date]
Period of report date greater than the given date. (provider: polygon)
period_of_report_date_gte : Optional[datetime.date]
Period of report date greater than or equal to the given date. (provider: polygon)
include_sources : Optional[bool]
Whether to include the sources of the financial statement. (provider: polygon)
order : Optional[Literal['asc', 'desc']]
Order of the financial statement. (provider: polygon)
sort : Optional[Literal['filing_date', 'period_of_report_date']]
Sort of the financial statement. (provider: polygon)
Returns
-------
OBBject
results : List[CashFlowStatement]
Serializable results.
provider : Optional[Literal['fmp', 'intrinio', 'polygon']]
Provider name.
warnings : Optional[List[Warning_]]
List of warnings.
chart : Optional[Chart]
Chart object.
extra: Dict[str, Any]
Extra info.
CashFlowStatement
-----------------
symbol : Optional[str]
Symbol to get data for.
date : date
Date of the fetched statement.
period : Optional[str]
Reporting period of the statement.
cik : Optional[str]
Central Index Key (CIK) of the company.
net_income : Optional[int]
Net income.
depreciation_and_amortization : Optional[int]
Depreciation and amortization.
stock_based_compensation : Optional[int]
Stock based compensation.
deferred_income_tax : Optional[int]
Deferred income tax.
other_non_cash_items : Optional[int]
Other non-cash items.
changes_in_operating_assets_and_liabilities : Optional[int]
Changes in operating assets and liabilities.
accounts_receivables : Optional[int]
Accounts receivables.
inventory : Optional[int]
Inventory.
vendor_non_trade_receivables : Optional[int]
Vendor non-trade receivables.
other_current_and_non_current_assets : Optional[int]
Other current and non-current assets.
accounts_payables : Optional[int]
Accounts payables.
deferred_revenue : Optional[int]
Deferred revenue.
other_current_and_non_current_liabilities : Optional[int]
Other current and non-current liabilities.
net_cash_flow_from_operating_activities : Optional[int]
Net cash flow from operating activities.
purchases_of_marketable_securities : Optional[int]
Purchases of investments.
sales_from_maturities_of_investments : Optional[int]
Sales and maturities of investments.
investments_in_property_plant_and_equipment : Optional[int]
Investments in property, plant, and equipment.
payments_from_acquisitions : Optional[int]
Acquisitions, net of cash acquired, and other
other_investing_activities : Optional[int]
Other investing activities
net_cash_flow_from_investing_activities : Optional[int]
Net cash used for investing activities.
taxes_paid_on_net_share_settlement : Optional[int]
Taxes paid on net share settlement of equity awards.
dividends_paid : Optional[int]
Payments for dividends and dividend equivalents
common_stock_repurchased : Optional[int]
Payments related to repurchase of common stock
debt_proceeds : Optional[int]
Proceeds from issuance of term debt
debt_repayment : Optional[int]
Payments of long-term debt
other_financing_activities : Optional[int]
Other financing activities, net
net_cash_flow_from_financing_activities : Optional[int]
Net cash flow from financing activities.
net_change_in_cash : Optional[int]
Net increase (decrease) in cash, cash equivalents, and restricted cash
reported_currency : Optional[str]
Reported currency in the statement. (provider: fmp)
filling_date : Optional[date]
Filling date. (provider: fmp)
accepted_date : Optional[datetime]
Accepted date. (provider: fmp)
calendar_year : Optional[int]
Calendar year. (provider: fmp)
change_in_working_capital : Optional[int]
Change in working capital. (provider: fmp)
other_working_capital : Optional[int]
Other working capital. (provider: fmp)
common_stock_issued : Optional[int]
Common stock issued. (provider: fmp)
effect_of_forex_changes_on_cash : Optional[int]
Effect of forex changes on cash. (provider: fmp)
cash_at_beginning_of_period : Optional[int]
Cash at beginning of period. (provider: fmp)
cash_at_end_of_period : Optional[int]
Cash, cash equivalents, and restricted cash at end of period (provider: fmp)
operating_cash_flow : Optional[int]
Operating cash flow. (provider: fmp)
capital_expenditure : Optional[int]
Capital expenditure. (provider: fmp)
free_cash_flow : Optional[int]
Free cash flow. (provider: fmp)
link : Optional[str]
Link to the statement. (provider: fmp)
final_link : Optional[str]
Link to the final statement. (provider: fmp)""" # noqa: E501
inputs = filter_inputs(
provider_choices={
"provider": provider,
},
standard_params={
"symbol": ",".join(symbol) if isinstance(symbol, list) else symbol,
"period": period,
"limit": limit,
},
extra_params=kwargs,
)
return self._run(
"/stocks/fa/cash",
**inputs,
)
@_validate
def cash_growth(
self,
symbol: Annotated[
Union[str, List[str]],
OpenBBCustomParameter(description="Symbol to get data for."),
],
limit: Annotated[
int,
OpenBBCustomParameter(description="The number of data entries to return."),
] = 10,
provider: Optional[Literal["fmp"]] = None,
**kwargs
) -> OBBject[List[Data]]:
"""Cash Flow Statement Growth.
Parameters
----------
symbol : str
Symbol to get data for.
limit : int
The number of data entries to return.
provider : Optional[Literal['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.
Returns
-------
OBBject
results : List[CashFlowStatementGrowth]
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.
CashFlowStatementGrowth
-----------------------
symbol : Optional[str]
Symbol to get data for.
date : date
The date of the data.
period : str
Period the statement is returned for.
growth_net_income : float
Growth rate of net income.
growth_depreciation_and_amortization : float
Growth rate of depreciation and amortization.
growth_deferred_income_tax : float
Growth rate of deferred income tax.
growth_stock_based_compensation : float
Growth rate of stock-based compensation.
growth_change_in_working_capital : float
Growth rate of change in working capital.
growth_accounts_receivables : float
Growth rate of accounts receivables.
growth_inventory : float
Growth rate of inventory.
growth_accounts_payables : float
Growth rate of accounts payables.
growth_other_working_capital : float
Growth rate of other working capital.
growth_other_non_cash_items : float
Growth rate of other non-cash items.
growth_net_cash_provided_by_operating_activities : float
Growth rate of net cash provided by operating activities.
growth_investments_in_property_plant_and_equipment : float
Growth rate of investments in property, plant, and equipment.
growth_acquisitions_net : float
Growth rate of net acquisitions.
growth_purchases_of_investments : float
Growth rate of purchases of investments.
growth_sales_maturities_of_investments : float
Growth rate of sales maturities of investments.
growth_other_investing_activities : float
Growth rate of other investing activities.
growth_net_cash_used_for_investing_activities : float
Growth rate of net cash used for investing activities.
growth_debt_repayment : float
Growth rate of debt repayment.
growth_common_stock_issued : float
Growth rate of common stock issued.
growth_common_stock_repurchased : float
Growth rate of common stock repurchased.
growth_dividends_paid : float
Growth rate of dividends paid.
growth_other_financing_activities : float
Growth rate of other financing activities.
growth_net_cash_used_provided_by_financing_activities : float
Growth rate of net cash used/provided by financing activities.
growth_effect_of_forex_changes_on_cash : float
Growth rate of the effect of foreign exchange changes on cash.
growth_net_change_in_cash : float
Growth rate of net change in cash.
growth_cash_at_end_of_period : float
Growth rate of cash at the end of the period.
growth_cash_at_beginning_of_period : float
Growth rate of cash at the beginning of the period.
growth_operating_cash_flow : float
Growth rate of operating cash flow.
growth_capital_expenditure : float
Growth rate of capital expenditure.
growth_free_cash_flow : float
Growth rate of free cash flow.""" # noqa: E501
inputs = filter_inputs(
provider_choices={
"provider": provider,
},
standard_params={
"symbol": ",".join(symbol) if isinstance(symbol, list) else symbol,
"limit": limit,
},
extra_params=kwargs,
)
return self._run(
"/stocks/fa/cash_growth",
**inputs,
)
@_validate
def comp(
self,
symbol: Annotated[
Union[str, List[str]],
OpenBBCustomParameter(description="Symbol to get data for."),
],
provider: Optional[Literal["fmp"]] = None,
**kwargs
) -> OBBject[List[Data]]:
"""Executive Compensation.
Parameters
----------
symbol : str
Symbol to get data for.
provider : Optional[Literal['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.
Returns
-------
OBBject
results : List[ExecutiveCompensation]
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.
ExecutiveCompensation
---------------------
symbol : str
Symbol to get data for.
cik : Optional[str]
Central Index Key (CIK) of the company.
filing_date : date
Date of the filing.
accepted_date : datetime
Date the filing was accepted.
name_and_position : str
Name and position of the executive.
year : int
Year of the compensation.
salary : float
Salary of the executive.
bonus : float
Bonus of the executive.
stock_award : float
Stock award of the executive.
incentive_plan_compensation : float
Incentive plan compensation of the executive.
all_other_compensation : float
All other compensation of the executive.
total : float
Total compensation of the executive.
url : str
URL of the filing data.""" # noqa: E501
inputs = filter_inputs(
provider_choices={
"provider": provider,
},
standard_params={
"symbol": ",".join(symbol) if isinstance(symbol, list) else symbol,
},
extra_params=kwargs,
)
return self._run(
"/stocks/fa/comp",
**inputs,
)
@_validate
def comsplit(
self,
start_date: Annotated[
Union[datetime.date, None, str],
OpenBBCustomParameter(
description="Start date of the data, in YYYY-MM-DD format."
),
] = None,
end_date: Annotated[
Union[datetime.date, None, str],
OpenBBCustomParameter(
description="End date of the data, in YYYY-MM-DD format."
),
] = None,
provider: Optional[Literal["fmp"]] = None,
**kwargs
) -> OBBject[List[Data]]:
"""Stock Split Calendar.
Parameters
----------
start_date : Optional[datetime.date]
Start date of the data, in YYYY-MM-DD format.
end_date : Optional[datetime.date]
End date of the data, in YYYY-MM-DD format.
provider : Optional[Literal['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.
Returns
-------
OBBject
results : List[StockSplitCalendar]
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.
StockSplitCalendar
------------------
date : date
Date of the stock splits.
label : str
Label of the stock splits.
symbol : str
Symbol of the company.
numerator : float
Numerator of the stock splits.
denominator : float
Denominator of the stock splits.""" # noqa: E501
inputs = filter_inputs(
provider_choices={
"provider": provider,
},
standard_params={
"start_date": start_date,
"end_date": end_date,
},
extra_params=kwargs,
)
return self._run(
"/stocks/fa/comsplit",
**inputs,
)
@_validate
def divs(
self,
symbol: Annotated[
Union[str, List[str]],
OpenBBCustomParameter(description="Symbol to get data for."),
],
provider: Optional[Literal["fmp"]] = None,
**kwargs
) -> OBBject[List[Data]]:
"""Historical Dividends.
Parameters
----------
symbol : str
Symbol to get data for.
provider : Optional[Literal['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.
Returns
-------
OBBject
results : List[HistoricalDividends]
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.
HistoricalDividends
-------------------
date : date
Date of the historical dividends.
label : str
Label of the historical dividends.
adj_dividend : float
Adjusted dividend of the historical dividends.
dividend : float
Dividend of the historical dividends.
record_date : Optional[date]
Record date of the historical dividends.
payment_date : Optional[date]
Payment date of the historical dividends.
declaration_date : Optional[date]
Declaration date of the historical dividends.""" # noqa: E501
inputs = filter_inputs(
provider_choices={
"provider": provider,
},
standard_params={
"symbol": ",".join(symbol) if isinstance(symbol, list) else symbol,
},
extra_params=kwargs,
)
return self._run(
"/stocks/fa/divs",
**inputs,
)
@_validate
def earning(
self,
symbol: Annotated[
Union[str, List[str]],
OpenBBCustomParameter(description="Symbol to get data for."),
],
limit: Annotated[
Optional[int],
OpenBBCustomParameter(description="The number of data entries to return."),
] = 50,
provider: Optional[Literal["fmp"]] = None,
**kwargs
) -> OBBject[List[Data]]:
"""Earnings Calendar.
Parameters
----------
symbol : str
Symbol to get data for.
limit : Optional[int]
The number of data entries to return.
provider : Optional[Literal['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.
Returns
-------
OBBject
results : List[EarningsCalendar]
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.
EarningsCalendar
----------------
symbol : str
Symbol to get data for.
date : date
The date of the data.
eps : Optional[float]
EPS of the earnings calendar.
eps_estimated : Optional[float]
Estimated EPS of the earnings calendar.
time : str
Time of the earnings calendar.
revenue : Optional[float]
Revenue of the earnings calendar.
revenue_estimated : Optional[float]
Estimated revenue of the earnings calendar.
updated_from_date : Optional[date]
Updated from date of the earnings calendar.
fiscal_date_ending : date
Fiscal date ending of the earnings calendar.""" # noqa: E501
inputs = filter_inputs(
provider_choices={
"provider": provider,
},
standard_params={
"symbol": ",".join(symbol) if isinstance(symbol, list) else symbol,
"limit": limit,
},
extra_params=kwargs,
)
return self._run(
"/stocks/fa/earning",
**inputs,
)
@_validate
def emp(
self,
symbol: Annotated[
Union[str, List[str]],
OpenBBCustomParameter(description="Symbol to get data for."),
],
provider: Optional[Literal["fmp"]] = None,
**kwargs
) -> OBBject[List[Data]]:
"""Number of Employees.
Parameters
----------
symbol : str
Symbol to get data for.
provider : Optional[Literal['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.
Returns
-------
OBBject
results : List[HistoricalEmployees]
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.
HistoricalEmployees
-------------------
symbol : str
Symbol to get data for.
cik : int
CIK of the company to retrieve the historical employees of.
acceptance_time : datetime
Time of acceptance of the company employee.
period_of_report : date
Date of reporting of the company employee.
company_name : str
Registered name of the company to retrieve the historical employees of.
form_type : str
Form type of the company employee.
filing_date : date
Filing date of the company employee
employee_count : int
Count of employees of the company.
source : str
Source URL which retrieves this data for the company.""" # noqa: E501
inputs = filter_inputs(
provider_choices={
"provider": provider,
},
standard_params={
"symbol": ",".join(symbol) if isinstance(symbol, list) else symbol,
},
extra_params=kwargs,
)
return self._run(
"/stocks/fa/emp",
**inputs,
)
@_validate
def est(
self,
symbol: Annotated[
Union[str, List[str]],
OpenBBCustomParameter(description="Symbol to get data for."),
],
period: Annotated[
Literal["annual", "quarter"],
OpenBBCustomParameter(description="Period of the data to return."),
] = "annual",
limit: Annotated[
int,
OpenBBCustomParameter(description="The number of data entries to return."),
] = 30,
provider: Optional[Literal["fmp"]] = None,
**kwargs
) -> OBBject[List[Data]]:
"""Analyst Estimates.
Parameters
----------
symbol : str
Symbol to get data for.
period : Literal['quarter', 'annual']
Period of the data to return.
limit : int
The number of data entries to return.
provider : Optional[Literal['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.
Returns
-------
OBBject
results : List[AnalystEstimates]
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.
AnalystEstimates
----------------
symbol : str
Symbol to get data for.
date : date
A specific date to get data for.
estimated_revenue_low : int
Estimated revenue low.
estimated_revenue_high : int
Estimated revenue high.
estimated_revenue_avg : int
Estimated revenue average.
estimated_ebitda_low : int
Estimated EBITDA low.
estimated_ebitda_high : int
Estimated EBITDA high.
estimated_ebitda_avg : int
Estimated EBITDA average.
estimated_ebit_low : int
Estimated EBIT low.
estimated_ebit_high : int
Estimated EBIT high.
estimated_ebit_avg : int
Estimated EBIT average.
estimated_net_income_low : int
Estimated net income low.
estimated_net_income_high : int
Estimated net income high.
estimated_net_income_avg : int
Estimated net income average.
estimated_sga_expense_low : int
Estimated SGA expense low.
estimated_sga_expense_high : int
Estimated SGA expense high.
estimated_sga_expense_avg : int
Estimated SGA expense average.
estimated_eps_avg : float
Estimated EPS average.
estimated_eps_high : float
Estimated EPS high.
estimated_eps_low : float
Estimated EPS low.
number_analyst_estimated_revenue : int
Number of analysts who estimated revenue.
number_analysts_estimated_eps : int
Number of analysts who estimated EPS.""" # noqa: E501
inputs = filter_inputs(
provider_choices={
"provider": provider,
},
standard_params={
"symbol": ",".join(symbol) if isinstance(symbol, list) else symbol,
"period": period,
"limit": limit,
},
extra_params=kwargs,
)
return self._run(
"/stocks/fa/est",
**inputs,
)
@_validate
def filings(
self,
symbol: Annotated[
Union[str, List[str]],
OpenBBCustomParameter(description="Symbol to get data for."),
],
limit: Annotated[
Optional[int],
OpenBBCustomParameter(description="The number of data entries to return."),
] = 100,
provider: Optional[Literal["fmp"]] = None,
**kwargs
) -> OBBject[List[Data]]:
"""Company Filings.
Parameters
----------
symbol : str
Symbol to get data for.
limit : Optional[int]
The number of data entries to return.
provider : Optional[Literal['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.
type : Optional[Literal['1', '1-A', '1-E', '1-K', '1-N', '1-SA', '1-U', '1-Z', '10', '10-D', '10-K', '10-M', '10-Q', '11-K', '12b-25', '13F', '13H', '144', '15', '15F', '17-H', '18', '18-K', '19b-4', '19b-4(e)', '19b-7', '2-E', '20-F', '24F-2', '25', '3', '4', '40-F', '5', '6-K', '7-M', '8-A', '8-K', '8-M', '9-M', 'ABS-15G', 'ABS-EE', 'ABS DD-15E', 'ADV', 'ADV-E', 'ADV-H', 'ADV-NR', 'ADV-W', 'ATS', 'ATS-N', 'ATS-R', 'BD', 'BD-N', 'BDW', 'C', 'CA-1', 'CB', 'CFPORTAL', 'CRS', 'CUSTODY', 'D', 'F-1', 'F-10', 'F-3', 'F-4', 'F-6', 'F-7', 'F-8', 'F-80', 'F-N', 'F-X', 'ID', 'MA', 'MA-I', 'MA-NR', 'MA-W', 'MSD', 'MSDW', 'N-14', 'N-17D-1', 'N-17f-1', 'N-17f-2', 'N-18f-1', 'N-1A', 'N-2', 'N-23c-3', 'N-27D-1', 'N-3', 'N-4', 'N-5', 'N-54A', 'N-54C', 'N-6', 'N-6EI-1', 'N-6F', 'N-8A', 'N-8B-2', 'N-8B-4', 'N-8F', 'N-CEN']]
Type of the SEC filing form. (provider: fmp)
page : Optional[int]
Page number of the results. (provider: fmp)
Returns
-------
OBBject
results : List[CompanyFilings]
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.
CompanyFilings
--------------
date : date
The date of the filing.
type : str
Type of document.
link : str
URL to the document.
symbol : Optional[str]
The ticker symbol of the company. (provider: fmp)
cik : Optional[str]
CIK of the SEC filing. (provider: fmp)
accepted_date : Optional[datetime]
Accepted date of the SEC filing. (provider: fmp)
final_link : Optional[str]
Final link of the SEC filing. (provider: fmp)""" # noqa: E501
inputs = filter_inputs(
provider_choices={
"provider": provider,
},
standard_params={
"symbol": ",".join(symbol) if isinstance(symbol, list) else symbol,
"limit": limit,
},
extra_params=kwargs,
)
return self._run(
"/stocks/fa/filings",
**inputs,
)
@_validate
def income(
self,
symbol: Annotated[
Union[str, List[str]],
OpenBBCustomParameter(description="Symbol to get data for."),
],
period: Annotated[
Literal["annual", "quarter"],
OpenBBCustomParameter(description="Period of the data to return."),
] = "annual",
limit: Annotated[
int,
OpenBBCustomParameter(description="The number of data entries to return."),
] = 12,
provider: Optional[Literal["fmp", "intrinio", "polygon"]] = None,
**kwargs
) -> OBBject[List[Data]]:
"""Income Statement.
Parameters
----------
symbol : str
Symbol to get data for.
period : Literal['annual', 'quarter']
Period of the data to return.
limit : int
The number of data entries to return.
provider : Optional[Literal['fmp', 'intrinio', 'polygon']]
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.
cik : Optional[str]
The CIK of the company if no symbol is provided. (provider: fmp)
type : Literal['reported', 'standardized']
Type of the statement to be fetched. (provider: intrinio)
year : Optional[int]
Year of the statement to be fetched. (provider: intrinio)
company_name : Optional[str]
Name of the company. (provider: polygon)
company_name_search : Optional[str]
Name of the company to search. (provider: polygon)
sic : Optional[str]
The Standard Industrial Classification (SIC) of the company. (provider: polygon)
filing_date : Optional[datetime.date]
Filing date of the financial statement. (provider: polygon)
filing_date_lt : Optional[datetime.date]
Filing date less than the given date. (provider: polygon)
filing_date_lte : Optional[datetime.date]
Filing date less than or equal to the given date. (provider: polygon)
filing_date_gt : Optional[datetime.date]
Filing date greater than the given date. (provider: polygon)
filing_date_gte : Optional[datetime.date]
Filing date greater than or equal to the given date. (provider: polygon)
period_of_report_date : Optional[datetime.date]
Period of report date of the financial statement. (provider: polygon)
period_of_report_date_lt : Optional[datetime.date]
Period of report date less than the given date. (provider: polygon)
period_of_report_date_lte : Optional[datetime.date]
Period of report date less than or equal to the given date. (provider: polygon)
period_of_report_date_gt : Optional[datetime.date]
Period of report date greater than the given date. (provider: polygon)
period_of_report_date_gte : Optional[datetime.date]
Period of report date greater than or equal to the given date. (provider: polygon)
include_sources : Optional[bool]
Whether to include the sources of the financial statement. (provider: polygon)
order : Optional[Literal['asc', 'desc']]
Order of the financial statement. (provider: polygon)
sort : Optional[Literal['filing_date', 'period_of_report_date']]
Sort of the financial statement. (provider: polygon)
Returns
-------
OBBject
results : List[IncomeStatement]
Serializable results.
provider : Optional[Literal['fmp', 'intrinio', 'polygon']]
Provider name.
warnings : Optional[List[Warning_]]
List of warnings.
chart : Optional[Chart]
Chart object.
extra: Dict[str, Any]
Extra info.
IncomeStatement
---------------
symbol : Optional[str]
Symbol to get data for.
date : date
Date of the income statement.
period : Optional[str]
Period of the income statement.
cik : Optional[str]
Central Index Key.
revenue : Optional[int]
Revenue.
cost_of_revenue : Optional[int]
Cost of revenue.
gross_profit : Optional[int]
Gross profit.
cost_and_expenses : Optional[int]
Cost and expenses.
gross_profit_ratio : Optional[float]
Gross profit ratio.
research_and_development_expenses : Optional[int]
Research and development expenses.
general_and_administrative_expenses : Optional[int]
General and administrative expenses.
selling_and_marketing_expenses : Optional[float]
Selling and marketing expenses.
selling_general_and_administrative_expenses : Optional[int]
Selling, general and administrative expenses.
other_expenses : Optional[int]
Other expenses.
operating_expenses : Optional[int]
Operating expenses.
depreciation_and_amortization : Optional[int]
Depreciation and amortization.
ebitda : Optional[int]
Earnings before interest, taxes, depreciation and amortization.
ebitda_ratio : Optional[float]
Earnings before interest, taxes, depreciation and amortization ratio.
operating_income : Optional[int]
Operating income.
operating_income_ratio : Optional[float]
Operating income ratio.
interest_income : Optional[int]
Interest income.
interest_expense : Optional[int]
Interest expense.
total_other_income_expenses_net : Optional[int]
Total other income expenses net.
income_before_tax : Optional[int]
Income before tax.
income_before_tax_ratio : Optional[float]
Income before tax ratio.
income_tax_expense : Optional[int]
Income tax expense.
net_income : Optional[int]
Net income.
net_income_ratio : Optional[float]
Net income ratio.
eps : Optional[float]
Earnings per share.
eps_diluted : Optional[float]
Earnings per share diluted.
weighted_average_shares_outstanding : Optional[int]
Weighted average shares outstanding.
weighted_average_shares_outstanding_dil : Optional[int]
Weighted average shares outstanding diluted.
link : Optional[str]
Link to the income statement.
final_link : Optional[str]
Final link to the income statement.
reported_currency : Optional[str]
Reporting currency. (provider: fmp)
filling_date : Optional[date]
Filling date. (provider: fmp)
accepted_date : Optional[datetime]
Accepted date. (provider: fmp)
calendar_year : Optional[int]
Calendar year. (provider: fmp)
income_loss_from_continuing_operations_before_tax : Optional[float]
Income/Loss From Continuing Operations After Tax (provider: polygon)
income_loss_from_continuing_operations_after_tax : Optional[float]
Income (loss) from continuing operations after tax (provider: polygon)
benefits_costs_expenses : Optional[float]
Benefits, costs and expenses (provider: polygon)
net_income_loss_attributable_to_noncontrolling_interest : Optional[int]
Net income (loss) attributable to noncontrolling interest (provider: polygon)
net_income_loss_attributable_to_parent : Optional[float]
Net income (loss) attributable to parent (provider: polygon)
net_income_loss_available_to_common_stockholders_basic : Optional[float]
Net Income/Loss Available To Common Stockholders Basic (provider: polygon)
participating_securities_distributed_and_undistributed_earnings_loss_basic : Optional[float]
Participating Securities Distributed And Undistributed Earnings Loss Basic (provider: polygon)
nonoperating_income_loss : Optional[float]
Nonoperating Income Loss (provider: polygon)
preferred_stock_dividends_and_other_adjustments : Optional[float]
Preferred stock dividends and other adjustments (provider: polygon)""" # noqa: E501
inputs = filter_inputs(
provider_choices={
"provider": provider,
},
standard_params={
"symbol": ",".join(symbol) if isinstance(symbol, list) else symbol,
"period": period,
"limit": limit,
},
extra_params=kwargs,
)
return self._run(
"/stocks/fa/income",
**inputs,
)
@_validate
def income_growth(
self,
symbol: Annotated[
Union[str, List[str]],
OpenBBCustomParameter(description="Symbol to get data for."),
],
limit: Annotated[
int,
OpenBBCustomParameter(description="The number of data entries to return."),
] = 10,
period: Annotated[
Literal["annual", "quarter"],
OpenBBCustomParameter(description="Period of the data to return."),
] = "annual",
provider: Optional[Literal["fmp"]] = None,
**kwargs
) -> OBBject[List[Data]]:
"""Income Statement Growth.
Parameters
----------
symbol : str
Symbol to get data for.
limit : int
The number of data entries to return.
period : Literal['annual', 'quarter']
Period of the data to return.
provider : Optional[Literal['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.
Returns
-------
OBBject
results : List[IncomeStatementGrowth]
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.
IncomeStatementGrowth
---------------------
symbol : Optional[str]
Symbol to get data for.
date : date
The date of the data.
period : str
Period the statement is returned for.
growth_revenue : float
Growth rate of total revenue.
growth_cost_of_revenue : float
Growth rate of cost of goods sold.
growth_gross_profit : float
Growth rate of gross profit.
growth_gross_profit_ratio : float
Growth rate of gross profit as a percentage of revenue.
growth_research_and_development_expenses : float
Growth rate of expenses on research and development.
growth_general_and_administrative_expenses : float
Growth rate of general and administrative expenses.
growth_selling_and_marketing_expenses : float
Growth rate of expenses on selling and marketing activities.
growth_other_expenses : float
Growth rate of other operating expenses.
growth_operating_expenses : float
Growth rate of total operating expenses.
growth_cost_and_expenses : float
Growth rate of total costs and expenses.
growth_interest_expense : float
Growth rate of interest expenses.
growth_depreciation_and_amortization : float
Growth rate of depreciation and amortization expenses.
growth_ebitda : float
Growth rate of Earnings Before Interest, Taxes, Depreciation, and Amortization.
growth_ebitda_ratio : float
Growth rate of EBITDA as a percentage of revenue.
growth_operating_income : float
Growth rate of operating income.
growth_operating_income_ratio : float
Growth rate of operating income as a percentage of revenue.
growth_total_other_income_expenses_net : float
Growth rate of net total other income and expenses.
growth_income_before_tax : float
Growth rate of income before taxes.
growth_income_before_tax_ratio : float
Growth rate of income before taxes as a percentage of revenue.
growth_income_tax_expense : float
Growth rate of income tax expenses.
growth_net_income : float
Growth rate of net income.
growth_net_income_ratio : float
Growth rate of net income as a percentage of revenue.
growth_eps : float
Growth rate of Earnings Per Share (EPS).
growth_eps_diluted : float
Growth rate of diluted Earnings Per Share (EPS).
growth_weighted_average_shs_out : float
Growth rate of weighted average shares outstanding.
growth_weighted_average_shs_out_dil : float
Growth rate of diluted weighted average shares outstanding.""" # noqa: E501
inputs = filter_inputs(
provider_choices={
"provider": provider,
},
standard_params={
"symbol": ",".join(symbol) if isinstance(symbol, list) else symbol,
"limit": limit,
"period": period,
},
extra_params=kwargs,
)
return self._run(
"/stocks/fa/income_growth",
**inputs,
)
@_validate
def ins(
self,
symbol: Annotated[
Union[str, List[str]],
OpenBBCustomParameter(description="Symbol to get data for."),
],
transactionType: Annotated[
Union[
List[
Literal[
"A-Award",
"C-Conversion",
"D-Return",
"E-ExpireShort",
"F-InKind",
"G-Gift",
"H-ExpireLong",
"I-Discretionary",
"J-Other",
"L-Small",
"M-Exempt",
"O-OutOfTheMoney",
"P-Purchase",
"S-Sale",
"U-Tender",
"W-Will",
"X-InTheMoney",
"Z-Trust",
]
],
str,
None,
],
OpenBBCustomParameter(description="Type of the transaction."),
] = ["P-Purchase"],
page: Annotated[
Optional[int],
OpenBBCustomParameter(description="Page number of the data to fetch."),
] = 0,
provider: Optional[Literal["fmp"]] = None,
**kwargs
) -> OBBject[List[Data]]:
"""Stock Insider Trading.
Parameters
----------
symbol : str
Symbol to get data for.
transactionType : Union[List[Literal['A-Award', 'C-Conversion', 'D-Return', ...
Type of the transaction.
page : Optional[int]
Page number of the data to fetch.
provider : Optional[Literal['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.
Returns
-------
OBBject
results : List[StockInsiderTrading]
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.
StockInsiderTrading
-------------------
symbol : str
Symbol to get data for.
filing_date : datetime
Filing date of the stock insider trading.
transaction_date : date
Transaction date of the stock insider trading.
reporting_cik : int
Reporting CIK of the stock insider trading.
transaction_type : str
Transaction type of the stock insider trading.
securities_owned : int
Securities owned of the stock insider trading.
company_cik : int
Company CIK of the stock insider trading.
reporting_name : str
Reporting name of the stock insider trading.
type_of_owner : str
Type of owner of the stock insider trading.
acquisition_or_disposition : str
Acquisition or disposition of the stock insider trading.
form_type : str
Form type of the stock insider trading.
securities_transacted : float
Securities transacted of the stock insider trading.
price : float
Price of the stock insider trading.
security_name : str
Security name of the stock insider trading.
link : str
Link of the stock insider trading.""" # noqa: E501
inputs = filter_inputs(
provider_choices={
"provider": provider,
},
standard_params={
"symbol": ",".join(symbol) if isinstance(symbol, list) else symbol,
"transactionType": transactionType,
"page": page,
},
extra_params=kwargs,
)
return self._run(
"/stocks/fa/ins",
**inputs,
)
@_validate
def ins_own(
self,
symbol: Annotated[
Union[str, List[str]],
OpenBBCustomParameter(description="Symbol to get data for."),
],
include_current_quarter: Annotated[
Optional[bool],
OpenBBCustomParameter(description="Include current quarter data."),
] = False,
date: Annotated[
Optional[datetime.date],
OpenBBCustomParameter(description="A specific date to get data for."),
] = None,
provider: Optional[Literal["fmp"]] = None,
**kwargs
) -> OBBject[List[Data]]:
"""Institutional Ownership.
Parameters
----------
symbol : str
Symbol to get data for.
include_current_quarter : Optional[bool]
Include current quarter data.
date : Optional[datetime.date]
A specific date to get data for.
provider : Optional[Literal['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.
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 to get data for.
cik : Optional[str]
CIK of the company.
date : date
The date of the data.
investors_holding : int
Number of investors holding the stock.
last_investors_holding : int
Number of investors holding the stock in the last quarter.
investors_holding_change : int
Change in the number of investors holding the stock.
number_of_13f_shares : Optional[int]
Number of 13F shares.
last_number_of_13f_shares : Optional[int]
Number of 13F shares in the last quarter.
number_of_13f_shares_change : Optional[int]
Change in the number of 13F shares.
total_invested : float
Total amount invested.
last_total_invested : float
Total amount invested in the last quarter.
total_invested_change : float
Change in the total amount invested.
ownership_percent : float
Ownership percent.
last_ownership_percent : float
Ownership percent in the last quarter.
ownership_percent_change : float
Change in the ownership percent.
new_positions : int
Number of new positions.
last_new_positions : int
Number of new positions in the last quarter.
new_positions_change : int
Change in the number of new positions.
increased_positions : int
Number of increased positions.
last_increased_positions : int
Number of increased positions in the last quarter.
increased_positions_change : int
Change in the number of increased positions.
closed_positions : int
Number of closed positions.
last_closed_positions : int
Number of closed positions in the last quarter.
closed_positions_change : int
Change in the number of closed positions.
reduced_positions : int
Number of reduced positions.
last_reduced_positions : int
Number of reduced positions in the last quarter.
reduced_positions_change : int
Change in the number of reduced positions.
total_calls : int
Total number of call options contracts traded for Apple Inc. on the specified date.
last_total_calls : int
Total number of call options contracts traded for Apple Inc. on the previous reporting date.
total_calls_change : int
Change in the total number of call options contracts traded between the current and previous reporting dates.
total_puts : int
Total number of put options contracts traded for Apple Inc. on the specified date.
last_total_puts : int
Total number of put options contracts traded for Apple Inc. on the previous reporting date.
total_puts_change : int
Change in the total number of put options contracts traded between the current and previous reporting dates.
put_call_ratio : float
Put-call ratio, which is the ratio of the total number of put options to call options traded on the specified date.
last_put_call_ratio : float
Put-call ratio on the previous reporting date.
put_call_ratio_change : float
Change in the put-call ratio between the current and previous reporting dates.
""" # noqa: E501
inputs = filter_inputs(
provider_choices={
"provider": provider,
},
standard_params={
"symbol": ",".join(symbol) if isinstance(symbol, list) else symbol,
"include_current_quarter": include_current_quarter,
"date": date,
},
extra_params=kwargs,
)
return self._run(
"/stocks/fa/ins_own",
**inputs,
)
@_validate
def metrics(
self,
symbol: Annotated[
Union[str, List[str]],
OpenBBCustomParameter(description="Symbol to get data for."),
],
period: Annotated[
Optional[Literal["annual", "quarter"]],
OpenBBCustomParameter(description="Period of the data to return."),
] = "annual",
limit: Annotated[
Optional[int],
OpenBBCustomParameter(description="The number of data entries to return."),
] = 100,
provider: Optional[Literal["fmp"]] = None,
**kwargs
) -> OBBject[List[Data]]:
"""Key Metrics.
Parameters
----------
symbol : str
Symbol to get data for.
period : Optional[Literal['annual', 'quarter']]
Period of the data to return.
limit : Optional[int]
The number of data entries to return.
provider : Optional[Literal['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.
with_ttm : Optional[bool]
Include trailing twelve months (TTM) data. (provider: fmp)
Returns
-------
OBBject
results : List[KeyMetrics]
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.
KeyMetrics
----------
symbol : Optional[str]
Symbol to get data for.
date : date
The date of the data.
period : str
Period of the data.
revenue_per_share : Optional[float]
Revenue per share
net_income_per_share : Optional[float]
Net income per share
operating_cash_flow_per_share : Optional[float]
Operating cash flow per share
free_cash_flow_per_share : Optional[float]
Free cash flow per share
cash_per_share : Optional[float]
Cash per share
book_value_per_share : Optional[float]
Book value per share
tangible_book_value_per_share : Optional[float]
Tangible book value per share
shareholders_equity_per_share : Optional[float]
Shareholders equity per share
interest_debt_per_share : Optional[float]
Interest debt per share
market_cap : Optional[float]
Market capitalization
enterprise_value : Optional[float]
Enterprise value
pe_ratio : Optional[float]
Price-to-earnings ratio (P/E ratio)
price_to_sales_ratio : Optional[float]
Price-to-sales ratio
pocf_ratio : Optional[float]
Price-to-operating cash flow ratio
pfcf_ratio : Optional[float]
Price-to-free cash flow ratio
pb_ratio : Optional[float]
Price-to-book ratio
ptb_ratio : Optional[float]
Price-to-tangible book ratio
ev_to_sales : Optional[float]
Enterprise value-to-sales ratio
enterprise_value_over_ebitda : Optional[float]
Enterprise value-to-EBITDA ratio
ev_to_operating_cash_flow : Optional[float]
Enterprise value-to-operating cash flow ratio
ev_to_free_cash_flow : Optional[float]
Enterprise value-to-free cash flow ratio
earnings_yield : Optional[float]
Earnings yield
free_cash_flow_yield : Optional[float]
Free cash flow yield
debt_to_equity : Optional[float]
Debt-to-equity ratio
debt_to_assets : Optional[float]
Debt-to-assets ratio
net_debt_to_ebitda : Optional[float]
Net debt-to-EBITDA ratio
current_ratio : Optional[float]
Current ratio
interest_coverage : Optional[float]
Interest coverage
income_quality : Optional[float]
Income quality
dividend_yield : Optional[float]
Dividend yield
payout_ratio : Optional[float]
Payout ratio
sales_general_and_administrative_to_revenue : Optional[float]
Sales general and administrative expenses-to-revenue ratio
research_and_development_to_revenue : Optional[float]
Research and development expenses-to-revenue ratio
intangibles_to_total_assets : Optional[float]
Intangibles-to-total assets ratio
capex_to_operating_cash_flow : Optional[float]
Capital expenditures-to-operating cash flow ratio
capex_to_revenue : Optional[float]
Capital expenditures-to-revenue ratio
capex_to_depreciation : Optional[float]
Capital expenditures-to-depreciation ratio
stock_based_compensation_to_revenue : Optional[float]
Stock-based compensation-to-revenue ratio
graham_number : Optional[float]
Graham number
roic : Optional[float]
Return on invested capital
return_on_tangible_assets : Optional[float]
Return on tangible assets
graham_net_net : Optional[float]
Graham net-net working capital
working_capital : Optional[float]
Working capital
tangible_asset_value : Optional[float]
Tangible asset value
net_current_asset_value : Optional[float]
Net current asset value
invested_capital : Optional[float]
Invested capital
average_receivables : Optional[float]
Average receivables
average_payables : Optional[float]
Average payables
average_inventory : Optional[float]
Average inventory
days_sales_outstanding : Optional[float]
Days sales outstanding
days_payables_outstanding : Optional[float]
Days payables outstanding
days_of_inventory_on_hand : Optional[float]
Days of inventory on hand
receivables_turnover : Optional[float]
Receivables turnover
payables_turnover : Optional[float]
Payables turnover
inventory_turnover : Optional[float]
Inventory turnover
roe : Optional[float]
Return on equity
capex_per_share : Optional[float]
Capital expenditures per share
calendar_year : Optional[int]
Calendar year. (provider: fmp)""" # noqa: E501
inputs = filter_inputs(
provider_choices={
"provider": provider,
},
standard_params={
"symbol": ",".join(symbol) if isinstance(symbol, list) else symbol,
"period": period,
"limit": limit,
},
extra_params=kwargs,
)
return self._run(
"/stocks/fa/metrics",
**inputs,
)
@_validate
def mgmt(
self,
symbol: Annotated[
Union[str, List[str]],
OpenBBCustomParameter(description="Symbol to get data for."),
],
provider: Optional[Literal["fmp"]] = None,
**kwargs
) -> OBBject[List[Data]]:
"""Key Executives.
Parameters
----------
symbol : str
Symbol to get data for.
provider : Optional[Literal['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.
Returns
-------
OBBject
results : List[KeyExecutives]
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.
KeyExecutives
-------------
title : str
Designation of the key executive.
name : str
Name of the key executive.
pay : Optional[int]
Pay of the key executive.
currency_pay : str
Currency of the pay.
gender : Optional[str]
Gender of the key executive.
year_born : Optional[int]
Birth year of the key executive.
title_since : Optional[int]
Date the tile was held since.""" # noqa: E501
inputs = filter_inputs(
provider_choices={
"provider": provider,
},
standard_params={
"symbol": ",".join(symbol) if isinstance(symbol, list) else symbol,
},
extra_params=kwargs,
)
return self._run(
"/stocks/fa/mgmt",
**inputs,
)
@_validate
def overview(
self,
symbol: Annotated[
Union[str, List[str]],
OpenBBCustomParameter(description="Symbol to get data for."),
],
provider: Optional[Literal["fmp"]] = None,
**kwargs
) -> OBBject[Data]:
"""Company Overview.
Parameters
----------
symbol : str
Symbol to get data for.
provider : Optional[Literal['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.
Returns
-------
OBBject
results : CompanyOverview
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.
CompanyOverview
---------------
symbol : str
Symbol to get data for.
price : Optional[float]
Price of the company.
beta : Optional[float]
Beta of the company.
vol_avg : Optional[int]
Volume average of the company.
mkt_cap : Optional[int]
Market capitalization of the company.
last_div : Optional[float]
Last dividend of the company.
range : Optional[str]
Range of the company.
changes : Optional[float]
Changes of the company.
company_name : Optional[str]
Company name of the company.
currency : Optional[str]
Currency of the company.
cik : Optional[str]
CIK of the company.
isin : Optional[str]
ISIN of the company.
cusip : Optional[str]
CUSIP of the company.
exchange : Optional[str]
Exchange of the company.
exchange_short_name : Optional[str]
Exchange short name of the company.
industry : Optional[str]
Industry of the company.
website : Optional[str]
Website of the company.
description : Optional[str]
Description of the company.
ceo : Optional[str]
CEO of the company.
sector : Optional[str]
Sector of the company.
country : Optional[str]
Country of the company.
full_time_employees : Optional[str]
Full time employees of the company.
phone : Optional[str]
Phone of the company.
address : Optional[str]
Address of the company.
city : Optional[str]
City of the company.
state : Optional[str]
State of the company.
zip : Optional[str]
Zip of the company.
dcf_diff : Optional[float]
Discounted cash flow difference of the company.
dcf : Optional[float]
Discounted cash flow of the company.
image : Optional[str]
Image of the company.
ipo_date : Optional[date]
IPO date of the company.
default_image : bool
If the image is the default image.
is_etf : bool
If the company is an ETF.
is_actively_trading : bool
If the company is actively trading.
is_adr : bool
If the company is an ADR.
is_fund : bool
If the company is a fund.""" # noqa: E501
inputs = filter_inputs(
provider_choices={
"provider": provider,
},
standard_params={
"symbol": ",".join(symbol) if isinstance(symbol, list) else symbol,
},
extra_params=kwargs,
)
return self._run(
"/stocks/fa/overview",
**inputs,
)
@_validate
def own(
self,
symbol: Annotated[
Union[str, List[str]],
OpenBBCustomParameter(description="Symbol to get data for."),
],
date: Annotated[
Optional[datetime.date],
OpenBBCustomParameter(description="A specific date to get data for."),
] = None,
page: Annotated[
Optional[int],
OpenBBCustomParameter(description="Page number of the data to fetch."),
] = 0,
provider: Optional[Literal["fmp"]] = None,
**kwargs
) -> OBBject[List[Data]]:
"""Stock Ownership.
Parameters
----------
symbol : str
Symbol to get data for.
date : Optional[datetime.date]
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 for the query, by default None.
If None, the provider specified in defaults is selected or 'fmp' if there is
no default.
Returns
-------
OBBject
results : List[StockOwnership]
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.
StockOwnership
--------------
date : date
The date of the data.
cik : int
Cik of the stock ownership.
filing_date : date
Filing date of the stock ownership.
investor_name : str
Investor name of the stock ownership.
symbol : str
Symbol of the stock ownership.
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.""" # noqa: E501
inputs = filter_inputs(
provider_choices={
"provider": provider,
},
standard_params={
"symbol": ",".join(symbol) if isinstance(symbol, list) else symbol,
"date": date,
"page": page,
},
extra_params=kwargs,
)
return self._run(
"/stocks/fa/own",
**inputs,
)
@_validate
def pt(
self,
symbol: Annotated[
Union[str, List[str]],
OpenBBCustomParameter(description="Symbol to get data for."),
],
provider: Optional[Literal["fmp"]] = None,
**kwargs
) -> OBBject[Data]:
"""Price Target Consensus.
Parameters
----------
symbol : str
Symbol to get data for.
provider : Optional[Literal['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.
Returns
-------
OBBject
results : PriceTargetConsensus
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.
PriceTargetConsensus
--------------------
symbol : str
Symbol to get data for.
target_high : Optional[float]
High target of the price target consensus.
target_low : Optional[float]
Low target of the price target consensus.
target_consensus : Optional[float]
Consensus target of the price target consensus.
target_median : Optional[float]
Median target of the price target consensus.""" # noqa: E501
inputs = filter_inputs(
provider_choices={
"provider": provider,
},
standard_params={
"symbol": ",".join(symbol) if isinstance(symbol, list) else symbol,
},
extra_params=kwargs,
)
return self._run(
"/stocks/fa/pt",
**inputs,
)
@_validate
def pta(
self,
symbol: Annotated[
Union[str, List[str]],
OpenBBCustomParameter(description="Symbol to get data for."),
],
provider: Optional[Literal["fmp"]] = None,
**kwargs
) -> OBBject[List[Data]]:
"""Price Target.
Parameters
----------
symbol : str
Symbol to get data for.
provider : Optional[Literal['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.
with_grade : bool
Include upgrades and downgrades in the response. (provider: fmp)
Returns
-------
OBBject
results : List[PriceTarget]
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.
PriceTarget
-----------
symbol : str
Symbol to get data for.
published_date : datetime
Published date of the price target.
news_url : Optional[str]
News URL of the price target.
news_title : Optional[str]
News title of the price target.
analyst_name : Optional[str]
Analyst name.
analyst_company : Optional[str]
Analyst company.
price_target : Optional[float]
Price target.
adj_price_target : Optional[float]
Adjusted price target.
price_when_posted : Optional[float]
Price when posted.
news_publisher : Optional[str]
News publisher of the price target.
news_base_url : Optional[str]
News base URL of the price target.
new_grade : Optional[str]
New grade (provider: fmp)
previous_grade : Optional[str]
Previous grade (provider: fmp)
grading_company : Optional[str]
Grading company (provider: fmp)""" # noqa: E501
inputs = filter_inputs(
provider_choices={
"provider": provider,
},
standard_params={
"symbol": ",".join(symbol) if isinstance(symbol, list) else symbol,
},
extra_params=kwargs,
)
return self._run(
"/stocks/fa/pta",
**inputs,
)
@_validate
def ratios(
self,
symbol: Annotated[
Union[str, List[str]],
OpenBBCustomParameter(description="Symbol to get data for."),
],
period: Annotated[
Literal["annual", "quarter"],
OpenBBCustomParameter(description="Period of the data to return."),
] = "annual",
limit: Annotated[
int,
OpenBBCustomParameter(description="The number of data entries to return."),
] = 12,
provider: Optional[Literal["fmp"]] = None,
**kwargs
) -> OBBject[List[Data]]:
"""Extensive set of ratios over time.
Parameters
----------
symbol : str
Symbol to get data for.
period : Literal['annual', 'quarter']
Period of the data to return.
limit : int
The number of data entries to return.
provider : Optional[Literal['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.
with_ttm : Optional[bool]
Include trailing twelve months (TTM) data. (provider: fmp)
Returns
-------
OBBject
results : List[FinancialRatios]
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.
FinancialRatios
---------------
symbol : str
Symbol of the company.
date : str
Date of the financial ratios.
period : str
Period of the financial ratios.
current_ratio : Optional[float]
Current ratio.
quick_ratio : Optional[float]
Quick ratio.
cash_ratio : Optional[float]
Cash ratio.
days_of_sales_outstanding : Optional[float]
Days of sales outstanding.
days_of_inventory_outstanding : Optional[float]
Days of inventory outstanding.
operating_cycle : Optional[float]
Operating cycle.
days_of_payables_outstanding : Optional[float]
Days of payables outstanding.
cash_conversion_cycle : Optional[float]
Cash conversion cycle.
gross_profit_margin : Optional[float]
Gross profit margin.
operating_profit_margin : Optional[float]
Operating profit margin.
pretax_profit_margin : Optional[float]
Pretax profit margin.
net_profit_margin : Optional[float]
Net profit margin.
effective_tax_rate : Optional[float]
Effective tax rate.
return_on_assets : Optional[float]
Return on assets.
return_on_equity : Optional[float]
Return on equity.
return_on_capital_employed : Optional[float]
Return on capital employed.
net_income_per_ebt : Optional[float]
Net income per EBT.
ebt_per_ebit : Optional[float]
EBT per EBIT.
ebit_per_revenue : Optional[float]
EBIT per revenue.
debt_ratio : Optional[float]
Debt ratio.
debt_equity_ratio : Optional[float]
Debt equity ratio.
long_term_debt_to_capitalization : Optional[float]
Long term debt to capitalization.
total_debt_to_capitalization : Optional[float]
Total debt to capitalization.
interest_coverage : Optional[float]
Interest coverage.
cash_flow_to_debt_ratio : Optional[float]
Cash flow to debt ratio.
company_equity_multiplier : Optional[float]
Company equity multiplier.
receivables_turnover : Optional[float]
Receivables turnover.
payables_turnover : Optional[float]
Payables turnover.
inventory_turnover : Optional[float]
Inventory turnover.
fixed_asset_turnover : Optional[float]
Fixed asset turnover.
asset_turnover : Optional[float]
Asset turnover.
operating_cash_flow_per_share : Optional[float]
Operating cash flow per share.
free_cash_flow_per_share : Optional[float]
Free cash flow per share.
cash_per_share : Optional[float]
Cash per share.
payout_ratio : Optional[float]
Payout ratio.
operating_cash_flow_sales_ratio : Optional[float]
Operating cash flow sales ratio.
free_cash_flow_operating_cash_flow_ratio : Optional[float]
Free cash flow operating cash flow ratio.
cash_flow_coverage_ratios : Optional[float]
Cash flow coverage ratios.
short_term_coverage_ratios : Optional[float]
Short term coverage ratios.
capital_expenditure_coverage_ratio : Optional[float]
Capital expenditure coverage ratio.
dividend_paid_and_capex_coverage_ratio : Optional[float]
Dividend paid and capex coverage ratio.
dividend_payout_ratio : Optional[float]
Dividend payout ratio.
price_book_value_ratio : Optional[float]
Price book value ratio.
price_to_book_ratio : Optional[float]
Price to book ratio.
price_to_sales_ratio : Optional[float]
Price to sales ratio.
price_earnings_ratio : Optional[float]
Price earnings ratio.
price_to_free_cash_flows_ratio : Optional[float]
Price to free cash flows ratio.
price_to_operating_cash_flows_ratio : Optional[float]
Price to operating cash flows ratio.
price_cash_flow_ratio : Optional[float]
Price cash flow ratio.
price_earnings_to_growth_ratio : Optional[float]
Price earnings to growth ratio.
price_sales_ratio : Optional[float]
Price sales ratio.
dividend_yield : Optional[float]
Dividend yield.
enterprise_value_multiple : Optional[float]
Enterprise value multiple.
price_fair_value : Optional[float]
Price fair value.""" # noqa: E501
inputs = filter_inputs(
provider_choices={
"provider": provider,
},
standard_params={
"symbol": ",".join(symbol) if isinstance(symbol, list) else symbol,
"period": period,
"limit": limit,
},
extra_params=kwargs,
)
return self._run(
"/stocks/fa/ratios",
**inputs,
)
@_validate
def revgeo(
self,
symbol: Annotated[
Union[str, List[str]],
OpenBBCustomParameter(description="Symbol to get data for."),
],
period: Annotated[
Literal["annual", "quarter"],
OpenBBCustomParameter(description="Period of the data to return."),
] = "annual",
structure: Annotated[
Literal["hierarchical", "flat"],
OpenBBCustomParameter(description="Structure of the returned data."),
] = "flat",
provider: Optional[Literal["fmp"]] = None,
**kwargs
) -> OBBject[List[Data]]:
"""Revenue Geographic.
Parameters
----------
symbol : str
Symbol to get data for.
period : Literal['quarter', 'annual']
Period of the data to return.
structure : Literal['hierarchical', 'flat']
Structure of the returned data.
provider : Optional[Literal['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.
Returns
-------
OBBject
results : List[RevenueGeographic]
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.
RevenueGeographic
-----------------
date : date
The date of the data.
geographic_segment : Dict[str, int]
Day level data containing the revenue of the geographic segment.
americas : Optional[int]
Revenue from the the American segment.
europe : Optional[int]
Revenue from the the European segment.
greater_china : Optional[int]
Revenue from the the Greater China segment.
japan : Optional[int]
Revenue from the the Japan segment.
rest_of_asia_pacific : Optional[int]
Revenue from the the Rest of Asia Pacific segment.""" # noqa: E501
inputs = filter_inputs(
provider_choices={
"provider": provider,
},
standard_params={
"symbol": ",".join(symbol) if isinstance(symbol, list) else symbol,
"period": period,
"structure": structure,
},
extra_params=kwargs,
)
return self._run(
"/stocks/fa/revgeo",
**inputs,
)
@_validate
def revseg(
self,
symbol: Annotated[
Union[str, List[str]],
OpenBBCustomParameter(description="Symbol to get data for."),
],
period: Annotated[
Literal["annual", "quarter"],
OpenBBCustomParameter(description="Period of the data to return."),
] = "annual",
structure: Annotated[
Literal["hierarchical", "flat"],
OpenBBCustomParameter(description="Structure of the returned data."),
] = "flat",
provider: Optional[Literal["fmp"]] = None,
**kwargs
) -> OBBject[List[Data]]:
"""Revenue Business Line.
Parameters
----------
symbol : str
Symbol to get data for.
period : Literal['quarter', 'annual']
Period of the data to return.
structure : Literal['hierarchical', 'flat']
Structure of the returned data.
provider : Optional[Literal['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.
Returns
-------
OBBject
results : List[RevenueBusinessLine]
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.
RevenueBusinessLine
-------------------
date : date
The date of the data.
business_line : Dict[str, int]
Day level data containing the revenue of the business line.""" # noqa: E501
inputs = filter_inputs(
provider_choices={
"provider": provider,
},
standard_params={
"symbol": ",".join(symbol) if isinstance(symbol, list) else symbol,
"period": period,
"structure": structure,
},
extra_params=kwargs,
)
return self._run(
"/stocks/fa/revseg",
**inputs,
)
@_validate
def shrs(
self,
symbol: Annotated[
Union[str, List[str]],
OpenBBCustomParameter(description="Symbol to get data for."),
],
provider: Optional[Literal["fmp"]] = None,
**kwargs
) -> OBBject[List[Data]]:
"""Share Statistics.
Parameters
----------
symbol : str
Symbol to get data for.
provider : Optional[Literal['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.
Returns
-------
OBBject
results : List[ShareStatistics]
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.
ShareStatistics
---------------
symbol : str
Symbol to get data for.
date : Optional[date]
A specific date to get data for.
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.""" # noqa: E501
inputs = filter_inputs(
provider_choices={
"provider": provider,
},
standard_params={
"symbol": ",".join(symbol) if isinstance(symbol, list) else symbol,
},
extra_params=kwargs,
)
return self._run(
"/stocks/fa/shrs",
**inputs,
)
@_validate
def split(
self,
symbol: Annotated[
Union[str, List[str]],
OpenBBCustomParameter(description="Symbol to get data for."),
],
provider: Optional[Literal["fmp"]] = None,
**kwargs
) -> OBBject[List[Data]]:
"""Historical Stock Splits.
Parameters
----------
symbol : str
Symbol to get data for.
provider : Optional[Literal['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.
Returns
-------
OBBject
results : List[HistoricalStockSplits]
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.
HistoricalStockSplits
---------------------
date : date
The date of the data.
label : str
Label of the historical stock splits.
numerator : float
Numerator of the historical stock splits.
denominator : float
Denominator of the historical stock splits.""" # noqa: E501
inputs = filter_inputs(
provider_choices={
"provider": provider,
},
standard_params={
"symbol": ",".join(symbol) if isinstance(symbol, list) else symbol,
},
extra_params=kwargs,
)
return self._run(
"/stocks/fa/split",
**inputs,
)
@_validate
def transcript(
self,
symbol: Annotated[
Union[str, List[str]],
OpenBBCustomParameter(description="Symbol to get data for."),
],
year: Annotated[
int,
OpenBBCustomParameter(description="Year of the earnings call transcript."),
],
quarter: Annotated[
int,
OpenBBCustomParameter(
description="Quarter of the earnings call transcript."
),
] = 1,
provider: Optional[Literal["fmp"]] = None,
**kwargs
) -> OBBject[List[Data]]:
"""Earnings Call Transcript.
Parameters
----------
symbol : str
Symbol to get data for.
year : int
Year of the earnings call transcript.
quarter : int
Quarter of the earnings call transcript.
provider : Optional[Literal['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.
Returns
-------
OBBject
results : List[EarningsCallTranscript]
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.
EarningsCallTranscript
----------------------
symbol : str
Symbol to get data for.
quarter : int
Quarter of the earnings call transcript.
year : int
Year of the earnings call transcript.
date : datetime
The date of the data.
content : str
Content of the earnings call transcript.""" # noqa: E501
inputs = filter_inputs(
provider_choices={
"provider": provider,
},
standard_params={
"symbol": ",".join(symbol) if isinstance(symbol, list) else symbol,
"year": year,
"quarter": quarter,
},
extra_params=kwargs,
)
return self._run(
"/stocks/fa/transcript",
**inputs,
)
Reference in New Issue View Git Blame Copy Permalink