Key Metrics
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
KeyMetrics | KeyMetricsQueryParams | KeyMetricsData |
Import Statement
from openbb_core.provider.standard_models.key_metrics import (
KeyMetricsData,
KeyMetricsQueryParams,
)
Parameters
- standard
- finviz
- fmp
- intrinio
- yfinance
symbol: str | list[str]
Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp, intrinio, yfinance.
symbol: str | list[str]
Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp, intrinio, yfinance.
symbol: str | list[str]
Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp, intrinio, yfinance.
ttm: Literal['include', 'exclude', 'only']
Default: only
Specify whether to include, exclude, or only show TTM (Trailing Twelve Months) data. The default is 'only'.
period: Literal['q1', 'q2', 'q3', 'q4', 'fy', 'annual', 'quarter']
Default: annual
Specify the fiscal period for the data. Ignored when TTM is set to 'only'.
limit: int
Only applicable when TTM is not set to 'only'. Defines the number of most recent reporting periods to return. The default is 5.
symbol: str | list[str]
Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp, intrinio, yfinance.
symbol: str | list[str]
Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp, intrinio, yfinance.
Data
- standard
- finviz
- fmp
- intrinio
- yfinance
symbol: str
Symbol representing the entity requested in the data.
period_ending: date
End date of the reporting period.
fiscal_year: int
Fiscal year for the fiscal period, if available.
fiscal_period: str
Fiscal period for the data, if available.
currency: str
Currency in which the data is reported.
market_cap: Union[float, int]
symbol: str
Symbol representing the entity requested in the data.
period_ending: date
End date of the reporting period.
fiscal_year: int
Fiscal year for the fiscal period, if available.
fiscal_period: str
Fiscal period for the data, if available.
currency: str
Currency in which the data is reported.
market_cap: Union[float, int]
pe_ratio: float
Price-to-earnings ratio (TTM).
foward_pe: float
Forward price-to-earnings ratio (forward P/E)
eps: float
Earnings per share (EPS)
price_to_sales: float
Price-to-sales ratio (P/S)
price_to_book: float
Price-to-book ratio (P/B)
book_value_per_share: float
Book value per share (Book/sh)
price_to_cash: float
Price-to-cash ratio (P/C)
cash_per_share: float
Cash per share (Cash/sh)
price_to_free_cash_flow: float
Price-to-free cash flow ratio (P/FCF)
debt_to_equity: float
Debt-to-equity ratio (Debt/Eq)
long_term_debt_to_equity: float
Long-term debt-to-equity ratio (LT Debt/Eq)
quick_ratio: float
Quick ratio
current_ratio: float
Current ratio
gross_margin: float
Gross margin, as a normalized percent.
profit_margin: float
Profit margin, as a normalized percent.
operating_margin: float
Operating margin, as a normalized percent.
return_on_assets: float
Return on assets (ROA), as a normalized percent.
return_on_investment: float
Return on investment (ROI), as a normalized percent.
return_on_equity: float
Return on equity (ROE), as a normalized percent.
payout_ratio: float
Payout ratio, as a normalized percent.
dividend_yield: float
Dividend yield, as a normalized percent.
symbol: str
Symbol representing the entity requested in the data.
period_ending: date
End date of the reporting period.
fiscal_year: int
Fiscal year for the fiscal period, if available.
fiscal_period: str
Fiscal period for the data, if available.
currency: str
Currency in which the data is reported.
market_cap: Union[float, int]
enterprise_value: Union[float, int]
Enterprise Value.
ev_to_sales: float
Enterprise Value to Sales ratio.
ev_to_operating_cash_flow: float
Enterprise Value to Operating Cash Flow ratio.
ev_to_free_cash_flow: float
Enterprise Value to Free Cash Flow ratio.
ev_to_ebitda: float
Enterprise Value to EBITDA ratio.
net_debt_to_ebitda: float
Net Debt to EBITDA ratio.
current_ratio: float
Current Ratio.
income_quality: float
Income Quality.
graham_number: float
Graham Number.
graham_net_net: float
Graham Net Net.
tax_burden: float
Tax Burden.
interest_burden: float
Interest Burden.
working_capital: Union[float, int]
Working Capital.
invested_capital: Union[float, int]
Invested Capital.
return_on_assets: float
Return on Assets.
operating_return_on_assets: float
Operating Return on Assets.
return_on_tangible_assets: float
Return on Tangible Assets.
return_on_equity: float
Return on Equity.
return_on_invested_capital: float
Return on Invested Capital.
return_on_capital_employed: float
Return on Capital Employed.
earnings_yield: float
Earnings Yield.
free_cash_flow_yield: float
Free Cash Flow Yield.
capex_to_operating_cash_flow: float
Capex to Operating Cash Flow.
capex_to_depreciation: float
Capex to Depreciation.
capex_to_revenue: float
Capex to Revenue.
sales_general_and_administrative_to_revenue: float
Sales, General and Administrative to Revenue.
research_and_developement_to_revenue: float
Research and Development to Revenue.
stock_based_compensation_to_revenue: float
Stock Based Compensation to Revenue.
intangibles_to_total_assets: float
Intangibles to Total Assets.
average_receivables: Union[float, int]
Average Receivables.
average_payables: Union[float, int]
Average Payables.
average_inventory: Union[float, int]
Average Inventory.
days_of_sales_outstanding: float
Days of Sales Outstanding.
days_of_payables_outstanding: float
Days of Payables Outstanding.
days_of_inventory_outstanding: float
Days of Inventory Outstanding.
operating_cycle: float
Operating Cycle.
cash_conversion_cycle: float
Cash Conversion Cycle.
free_cash_flow_to_equity: float
Free Cash Flow to Equity.
free_cash_flow_to_firm: float
Free Cash Flow to Firm.
tangible_asset_value: Union[float, int]
Tangible Asset Value.
net_current_asset_value: Union[float, int]
Net Current Asset Value.
symbol: str
Symbol representing the entity requested in the data.
period_ending: date
End date of the reporting period.
fiscal_year: int
Fiscal year for the fiscal period, if available.
fiscal_period: str
Fiscal period for the data, if available.
currency: str
Currency in which the data is reported.
market_cap: Union[float, int]
pe_ratio: float
Price-to-earnings ratio (TTM).
price_to_book: float
Price to book ratio.
price_to_tangible_book: float
Price to tangible book ratio.
price_to_revenue: float
Price to revenue ratio.
quick_ratio: float
Quick ratio.
gross_margin: float
Gross margin, as a normalized percent.
ebit_margin: float
EBIT margin, as a normalized percent.
profit_margin: float
Profit margin, as a normalized percent.
eps: float
Basic earnings per share.
eps_growth: float
EPS growth, as a normalized percent.
revenue_growth: float
Revenue growth, as a normalized percent.
ebitda_growth: float
EBITDA growth, as a normalized percent.
ebit_growth: float
EBIT growth, as a normalized percent.
net_income_growth: float
Net income growth, as a normalized percent.
free_cash_flow_to_firm_growth: float
Free cash flow to firm growth, as a normalized percent.
invested_capital_growth: float
Invested capital growth, as a normalized percent.
return_on_assets: float
Return on assets, as a normalized percent.
return_on_equity: float
Return on equity, as a normalized percent.
return_on_invested_capital: float
Return on invested capital, as a normalized percent.
ebitda: int
Earnings before interest, taxes, depreciation, and amortization.
ebit: int
Earnings before interest and taxes.
long_term_debt: int
Long-term debt.
total_debt: int
Total debt.
total_capital: int
The sum of long-term debt and total shareholder equity.
enterprise_value: int
Enterprise value.
free_cash_flow_to_firm: int
Free cash flow to firm.
altman_z_score: float
Altman Z-score.
beta: float
Beta relative to the broad market (rolling three-year).
dividend_yield: float
Dividend yield, as a normalized percent.
earnings_yield: float
Earnings yield, as a normalized percent.
last_price: float
Last price of the stock.
year_high: float
52 week high
year_low: float
52 week low
volume_avg: int
Average daily volume.
short_interest: int
Number of shares reported as sold short.
shares_outstanding: int
Weighted average shares outstanding (TTM).
days_to_cover: float
Days to cover short interest, based on average daily volume.
symbol: str
Symbol representing the entity requested in the data.
period_ending: date
End date of the reporting period.
fiscal_year: int
Fiscal year for the fiscal period, if available.
fiscal_period: str
Fiscal period for the data, if available.
currency: str
Currency in which the data is presented.
market_cap: Union[float, int]
pe_ratio: float
Price-to-earnings ratio (TTM).
forward_pe: float
Forward price-to-earnings ratio.
peg_ratio: float
PEG ratio (5-year expected).
peg_ratio_ttm: float
PEG ratio (TTM).
eps_ttm: float
Earnings per share (TTM).
eps_forward: float
Forward earnings per share.
enterprise_to_ebitda: float
Enterprise value to EBITDA ratio.
earnings_growth: float
Earnings growth (Year Over Year), as a normalized percent.
earnings_growth_quarterly: float
Quarterly earnings growth (Year Over Year), as a normalized percent.
revenue_per_share: float
Revenue per share (TTM).
revenue_growth: float
Revenue growth (Year Over Year), as a normalized percent.
enterprise_to_revenue: float
Enterprise value to revenue ratio.
cash_per_share: float
Cash per share.
quick_ratio: float
Quick ratio.
current_ratio: float
Current ratio.
debt_to_equity: float
Debt-to-equity ratio.
gross_margin: float
Gross margin, as a normalized percent.
operating_margin: float
Operating margin, as a normalized percent.
ebitda_margin: float
EBITDA margin, as a normalized percent.
profit_margin: float
Profit margin, as a normalized percent.
return_on_assets: float
Return on assets, as a normalized percent.
return_on_equity: float
Return on equity, as a normalized percent.
dividend_yield: float
Dividend yield, as a normalized percent.
dividend_yield_5y_avg: float
5-year average dividend yield, as a normalized percent.
payout_ratio: float
Payout ratio.
book_value: float
Book value per share.
price_to_book: float
Price-to-book ratio.
enterprise_value: int
Enterprise value.
overall_risk: float
Overall risk score.
audit_risk: float
Audit risk score.
board_risk: float
Board risk score.
compensation_risk: float
Compensation risk score.
shareholder_rights_risk: float
Shareholder rights risk score.
beta: float
Beta relative to the broad market (5-year monthly).
price_return_1y: float
One-year price return, as a normalized percent.