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'] | None
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'] | None
Default: annual
Specify the fiscal period for the data. Ignored when TTM is set to 'only'.

limit: int | None
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 | None
End date of the reporting period.

fiscal_year: int | None
Fiscal year for the fiscal period, if available.

fiscal_period: str | None
Fiscal period for the data, if available.

currency: str | None
Currency in which the data is reported.

market_cap: int | float | None

symbol: str
Symbol representing the entity requested in the data.

period_ending: date | None
End date of the reporting period.

fiscal_year: int | None
Fiscal year for the fiscal period, if available.

fiscal_period: str | None
Fiscal period for the data, if available.

currency: str | None
Currency in which the data is reported.

market_cap: int | float | None
pe_ratio: float | None
Price-to-earnings ratio (TTM).

forward_pe: float | None
Forward price-to-earnings ratio (forward P/E)

eps: float | None
Earnings per share (EPS)

price_to_sales: float | None
Price-to-sales ratio (P/S)

price_to_book: float | None
Price-to-book ratio (P/B)

book_value_per_share: float | None
Book value per share (Book/sh)

price_to_cash: float | None
Price-to-cash ratio (P/C)

cash_per_share: float | None
Cash per share (Cash/sh)

price_to_free_cash_flow: float | None
Price-to-free cash flow ratio (P/FCF)

debt_to_equity: float | None
Debt-to-equity ratio (Debt/Eq)

long_term_debt_to_equity: float | None
Long-term debt-to-equity ratio (LT Debt/Eq)

quick_ratio: float | None
Quick ratio

current_ratio: float | None
Current ratio

gross_margin: float | None
Gross margin, as a normalized percent.

profit_margin: float | None
Profit margin, as a normalized percent.

operating_margin: float | None
Operating margin, as a normalized percent.

return_on_assets: float | None
Return on assets (ROA), as a normalized percent.

return_on_investment: float | None
Return on investment (ROI), as a normalized percent.

return_on_equity: float | None
Return on equity (ROE), as a normalized percent.

payout_ratio: float | None
Payout ratio, as a normalized percent.

dividend_yield: float | None
Dividend yield, as a normalized percent.

symbol: str
Symbol representing the entity requested in the data.

period_ending: date | None
End date of the reporting period.

fiscal_year: int | None
Fiscal year for the fiscal period, if available.

fiscal_period: str | None
Fiscal period for the data, if available.

currency: str | None
Currency in which the data is reported.

market_cap: int | float | None
enterprise_value: int | float | None
Enterprise Value.

ev_to_sales: float | None
Enterprise Value to Sales ratio.

ev_to_operating_cash_flow: float | None
Enterprise Value to Operating Cash Flow ratio.

ev_to_free_cash_flow: float | None
Enterprise Value to Free Cash Flow ratio.

ev_to_ebitda: float | None
Enterprise Value to EBITDA ratio.

net_debt_to_ebitda: float | None
Net Debt to EBITDA ratio.

current_ratio: float | None
Current Ratio.

income_quality: float | None
Income Quality.

graham_number: float | None
Graham Number.

graham_net_net: float | None
Graham Net Net.

tax_burden: float | None
Tax Burden.

interest_burden: float | None
Interest Burden.

working_capital: int | float | None
Working Capital.

invested_capital: int | float | None
Invested Capital.

return_on_assets: float | None
Return on Assets.

operating_return_on_assets: float | None
Operating Return on Assets.

return_on_tangible_assets: float | None
Return on Tangible Assets.

return_on_equity: float | None
Return on Equity.

return_on_invested_capital: float | None
Return on Invested Capital.

return_on_capital_employed: float | None
Return on Capital Employed.

earnings_yield: float | None
Earnings Yield.

free_cash_flow_yield: float | None
Free Cash Flow Yield.

capex_to_operating_cash_flow: float | None
Capex to Operating Cash Flow.

capex_to_depreciation: float | None
Capex to Depreciation.

capex_to_revenue: float | None
Capex to Revenue.

sales_general_and_administrative_to_revenue: float | None
Sales, General and Administrative to Revenue.

research_and_development_to_revenue: float | None
Research and Development to Revenue.

stock_based_compensation_to_revenue: float | None
Stock Based Compensation to Revenue.

intangibles_to_total_assets: float | None
Intangibles to Total Assets.

average_receivables: int | float | None
Average Receivables.

average_payables: int | float | None
Average Payables.

average_inventory: int | float | None
Average Inventory.

days_of_sales_outstanding: float | None
Days of Sales Outstanding.

days_of_payables_outstanding: float | None
Days of Payables Outstanding.

days_of_inventory_outstanding: float | None
Days of Inventory Outstanding.

operating_cycle: float | None
Operating Cycle.

cash_conversion_cycle: float | None
Cash Conversion Cycle.

free_cash_flow_to_equity: float | None
Free Cash Flow to Equity.

free_cash_flow_to_firm: float | None
Free Cash Flow to Firm.

tangible_asset_value: int | float | None
Tangible Asset Value.

net_current_asset_value: int | float | None
Net Current Asset Value.

symbol: str
Symbol representing the entity requested in the data.

period_ending: date | None
End date of the reporting period.

fiscal_year: int | None
Fiscal year for the fiscal period, if available.

fiscal_period: str | None
Fiscal period for the data, if available.

currency: str | None
Currency in which the data is reported.

market_cap: int | float | None
pe_ratio: float | None
Price-to-earnings ratio (TTM).

price_to_book: float | None
Price to book ratio.

price_to_tangible_book: float | None
Price to tangible book ratio.

price_to_revenue: float | None
Price to revenue ratio.

quick_ratio: float | None
Quick ratio.

gross_margin: float | None
Gross margin, as a normalized percent.

ebit_margin: float | None
EBIT margin, as a normalized percent.

profit_margin: float | None
Profit margin, as a normalized percent.

eps: float | None
Basic earnings per share.

eps_growth: float | None
EPS growth, as a normalized percent.

revenue_growth: float | None
Revenue growth, as a normalized percent.

ebitda_growth: float | None
EBITDA growth, as a normalized percent.

ebit_growth: float | None
EBIT growth, as a normalized percent.

net_income_growth: float | None
Net income growth, as a normalized percent.

free_cash_flow_to_firm_growth: float | None
Free cash flow to firm growth, as a normalized percent.

invested_capital_growth: float | None
Invested capital growth, as a normalized percent.

return_on_assets: float | None
Return on assets, as a normalized percent.

return_on_equity: float | None
Return on equity, as a normalized percent.

return_on_invested_capital: float | None
Return on invested capital, as a normalized percent.

ebitda: int | None
Earnings before interest, taxes, depreciation, and amortization.

ebit: int | None
Earnings before interest and taxes.

long_term_debt: int | None
Long-term debt.

total_debt: int | None
Total debt.

total_capital: int | None
The sum of long-term debt and total shareholder equity.

enterprise_value: int | None
Enterprise value.

free_cash_flow_to_firm: int | None
Free cash flow to firm.

altman_z_score: float | None
Altman Z-score.

beta: float | None
Beta relative to the broad market (rolling three-year).

dividend_yield: float | None
Dividend yield, as a normalized percent.

earnings_yield: float | None
Earnings yield, as a normalized percent.

last_price: float | None
Last price of the stock.

year_high: float | None
52 week high

year_low: float | None
52 week low

volume_avg: int | None
Average daily volume.

short_interest: int | None
Number of shares reported as sold short.

shares_outstanding: int | None
Weighted average shares outstanding (TTM).

days_to_cover: float | None
Days to cover short interest, based on average daily volume.

symbol: str
Symbol representing the entity requested in the data.

period_ending: date | None
End date of the reporting period.

fiscal_year: int | None
Fiscal year for the fiscal period, if available.

fiscal_period: str | None
Fiscal period for the data, if available.

currency: str | None
Currency in which the data is presented.

market_cap: int | float | None
pe_ratio: float | None
Price-to-earnings ratio (TTM).

forward_pe: float | None
Forward price-to-earnings ratio.

peg_ratio: float | None
PEG ratio (5-year expected).

peg_ratio_ttm: float | None
PEG ratio (TTM).

eps_ttm: float | None
Earnings per share (TTM).

eps_forward: float | None
Forward earnings per share.

enterprise_to_ebitda: float | None
Enterprise value to EBITDA ratio.

earnings_growth: float | None
Earnings growth (Year Over Year), as a normalized percent.

earnings_growth_quarterly: float | None
Quarterly earnings growth (Year Over Year), as a normalized percent.

revenue_per_share: float | None
Revenue per share (TTM).

revenue_growth: float | None
Revenue growth (Year Over Year), as a normalized percent.

enterprise_to_revenue: float | None
Enterprise value to revenue ratio.

cash_per_share: float | None
Cash per share.

quick_ratio: float | None
Quick ratio.

current_ratio: float | None
Current ratio.

debt_to_equity: float | None
Debt-to-equity ratio.

gross_margin: float | None
Gross margin, as a normalized percent.

operating_margin: float | None
Operating margin, as a normalized percent.

ebitda_margin: float | None
EBITDA margin, as a normalized percent.

profit_margin: float | None
Profit margin, as a normalized percent.

return_on_assets: float | None
Return on assets, as a normalized percent.

return_on_equity: float | None
Return on equity, as a normalized percent.

dividend_yield: float | None
Dividend yield, as a normalized percent.

dividend_yield_5y_avg: float | None
5-year average dividend yield, as a normalized percent.

payout_ratio: float | None
Payout ratio.

book_value: float | None
Book value per share.

price_to_book: float | None
Price-to-book ratio.

enterprise_value: int | None
Enterprise value.

overall_risk: float | None
Overall risk score.

audit_risk: float | None
Audit risk score.

board_risk: float | None
Board risk score.

compensation_risk: float | None
Compensation risk score.

shareholder_rights_risk: float | None
Shareholder rights risk score.

beta: float | None
Beta relative to the broad market (5-year monthly).

price_return_1y: float | None
One-year price return, as a normalized percent.