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

Name	Type	Description	Default	Optional
symbol	Union[str, List[str]]	Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp, intrinio, yfinance.		False
period	Literal['annual', 'quarter']	Time period of the data to return.	annual	True
limit	int	The number of data entries to return.	100	True
provider	Literal['finviz', 'fmp', 'intrinio', 'yfinance']	The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: f, i, n, v, i, z.	None	True

Name	Type	Description	Default	Optional
symbol	Union[str, List[str]]	Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp, intrinio, yfinance.		False
period	Literal['annual', 'quarter']	Time period of the data to return.	annual	True
limit	int	The number of data entries to return.	100	True
provider	Literal['finviz', 'fmp', 'intrinio', 'yfinance']	The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: f, i, n, v, i, z.	None	True

Name	Type	Description	Default	Optional
symbol	Union[str, List[str]]	Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp, intrinio, yfinance.		False
period	Literal['annual', 'quarter']	Time period of the data to return.	annual	True
limit	int	The number of data entries to return.	100	True
provider	Literal['finviz', 'fmp', 'intrinio', 'yfinance']	The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: f, i, n, v, i, z.	None	True
with_ttm	bool	Include trailing twelve months (TTM) data.	False	True

Name	Type	Description	Default	Optional
symbol	Union[str, List[str]]	Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp, intrinio, yfinance.		False
period	Literal['annual', 'quarter']	Time period of the data to return.	annual	True
limit	int	The number of data entries to return.	100	True
provider	Literal['finviz', 'fmp', 'intrinio', 'yfinance']	The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: f, i, n, v, i, z.	None	True

Name	Type	Description	Default	Optional
symbol	Union[str, List[str]]	Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp, intrinio, yfinance.		False
period	Literal['annual', 'quarter']	Time period of the data to return.	annual	True
limit	int	The number of data entries to return.	100	True
provider	Literal['finviz', 'fmp', 'intrinio', 'yfinance']	The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: f, i, n, v, i, z.	None	True

---

Data

• standard
• finviz
• fmp
• intrinio
• yfinance

Name	Type	Description
symbol	str	Symbol representing the entity requested in the data.
market_cap	float	Market capitalization
pe_ratio	float	Price-to-earnings ratio (P/E ratio)

Name	Type	Description
symbol	str	Symbol representing the entity requested in the data.
market_cap	float	Market capitalization
pe_ratio	float	Price-to-earnings ratio (P/E ratio)
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.

Name	Type	Description
symbol	str	Symbol representing the entity requested in the data.
market_cap	float	Market capitalization
pe_ratio	float	Price-to-earnings ratio (P/E ratio)
period_ending	date	Period ending date.
fiscal_period	str	Period of the data.
calendar_year	int	Calendar year for the fiscal period.
revenue_per_share	float	Revenue per share
capex_per_share	float	Capital expenditures per share
net_income_per_share	float	Net income per share
operating_cash_flow_per_share	float	Operating cash flow per share
free_cash_flow_per_share	float	Free cash flow per share
cash_per_share	float	Cash per share
book_value_per_share	float	Book value per share
tangible_book_value_per_share	float	Tangible book value per share
shareholders_equity_per_share	float	Shareholders equity per share
interest_debt_per_share	float	Interest debt per share
price_to_sales	float	Price-to-sales ratio
price_to_operating_cash_flow	float	Price-to-operating cash flow ratio
price_to_free_cash_flow	float	Price-to-free cash flow ratio
price_to_book	float	Price-to-book ratio
price_to_tangible_book	float	Price-to-tangible book ratio
ev_to_sales	float	Enterprise value-to-sales ratio
ev_to_ebitda	float	Enterprise value-to-EBITDA 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
earnings_yield	float	Earnings yield
free_cash_flow_yield	float	Free cash flow yield
debt_to_market_cap	float	Debt-to-market capitalization ratio
debt_to_equity	float	Debt-to-equity ratio
debt_to_assets	float	Debt-to-assets ratio
net_debt_to_ebitda	float	Net debt-to-EBITDA ratio
current_ratio	float	Current ratio
interest_coverage	float	Interest coverage
income_quality	float	Income quality
payout_ratio	float	Payout ratio
sales_general_and_administrative_to_revenue	float	Sales general and administrative expenses-to-revenue ratio
research_and_development_to_revenue	float	Research and development expenses-to-revenue ratio
intangibles_to_total_assets	float	Intangibles-to-total assets ratio
capex_to_operating_cash_flow	float	Capital expenditures-to-operating cash flow ratio
capex_to_revenue	float	Capital expenditures-to-revenue ratio
capex_to_depreciation	float	Capital expenditures-to-depreciation ratio
stock_based_compensation_to_revenue	float	Stock-based compensation-to-revenue ratio
working_capital	float	Working capital
tangible_asset_value	float	Tangible asset value
net_current_asset_value	float	Net current asset value
enterprise_value	float	Enterprise value
invested_capital	float	Invested capital
average_receivables	float	Average receivables
average_payables	float	Average payables
average_inventory	float	Average inventory
days_sales_outstanding	float	Days sales outstanding
days_payables_outstanding	float	Days payables outstanding
days_of_inventory_on_hand	float	Days of inventory on hand
receivables_turnover	float	Receivables turnover
payables_turnover	float	Payables turnover
inventory_turnover	float	Inventory turnover
return_on_equity	float	Return on equity
return_on_invested_capital	float	Return on invested capital
return_on_tangible_assets	float	Return on tangible assets
dividend_yield	float	Dividend yield, as a normalized percent.
graham_number	float	Graham number
graham_net_net	float	Graham net-net working capital

Name	Type	Description
symbol	str	Symbol representing the entity requested in the data.
market_cap	float	Market capitalization
pe_ratio	float	Price-to-earnings ratio (P/E ratio)
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.

Name	Type	Description
symbol	str	Symbol representing the entity requested in the data.
market_cap	float	Market capitalization
pe_ratio	float	Price-to-earnings ratio (P/E ratio)
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.
currency	str	Currency in which the data is presented.