Financial Ratios
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
FinancialRatios | FinancialRatiosQueryParams | FinancialRatiosData |
Import Statement
from openbb_core.provider.standard_models.financial_ratios import (
FinancialRatiosData,
FinancialRatiosQueryParams,
)
Parameters
- standard
- fmp
- intrinio
symbol: str | list[str]
Symbol to get data for. Multiple items allowed for provider(s): fmp.
limit: int | None
The number of data entries to return.
symbol: str | list[str]
Symbol to get data for. Multiple items allowed for provider(s): fmp.
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.
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.
symbol: str | list[str]
Symbol to get data for. Multiple items allowed for provider(s): fmp.
limit: int | None
The number of data entries to return.
period: Literal['annual', 'quarter', 'ttm', 'ytd'] | None
Default: annual
Time period of the data to return.
fiscal_year: int | None
The specific fiscal year. Reports do not go beyond 2008.
Data
- standard
- fmp
- intrinio
symbol: str | None
Symbol representing the entity requested in the data.
period_ending: date | None
The date of the data.
fiscal_period: str | None
Period of the financial ratios.
fiscal_year: int | None
Fiscal year.
symbol: str | None
Symbol representing the entity requested in the data.
period_ending: date | None
The date of the data.
fiscal_period: str | None
Period of the financial ratios.
fiscal_year: int | None
Fiscal year.
currency: str | None
Currency in which the company reports financials.
gross_profit_margin: float | None
Gross profit margin.
ebit_margin: float | None
Earnings before interest and taxes (EBIT) margin.
ebitda_margin: float | None
Earnings before interest, taxes, depreciation, and amortization (EBITDA) margin.
operating_profit_margin: float | None
Operating profit margin.
pretax_profit_margin: float | None
Pretax profit margin.
continuous_operations_profit_margin: float | None
Continuous operations profit margin.
net_profit_margin: float | None
Net profit margin.
bottom_line_profit_margin: float | None
Bottom line profit margin.
receivables_turnover: float | None
Receivables turnover ratio.
payables_turnover: float | None
Payables turnover ratio.
inventory_turnover: float | None
Inventory turnover ratio.
fixed_asset_turnover: float | None
Fixed asset turnover ratio.
asset_turnover: float | None
Asset turnover ratio.
current_ratio: float | None
Current ratio.
quick_ratio: float | None
Quick ratio.
solvency_ratio: float | None
Solvency ratio.
cash_ratio: float | None
Cash ratio.
price_to_earnings: float | None
Price to earnings (P/E) ratio.
price_to_earnings_growth: float | None
Price to earnings growth (PEG) ratio.
forward_price_to_earnings_growth: float | None
Forward price to earnings growth (PEG) ratio.
price_to_book: float | None
Price to book (P/B) ratio.
price_to_sales: float | None
Price to sales (P/S) ratio.
price_to_free_cash_flow: float | None
Price to free cash flow (P/FCF) ratio.
price_to_operating_cash_flow: float | None
Price to operating cash flow (P/OCF) ratio.
debt_to_assets: float | None
Debt to assets ratio.
debt_to_equity: float | None
Debt to equity ratio.
debt_to_capital: float | None
Debt to capital ratio.
long_term_debt_to_capital: float | None
Long-term debt to capital ratio.
financial_leverage_ratio: float | None
Financial leverage ratio.
working_capital_turnover_ratio: float | None
Working capital turnover ratio.
operating_cash_flow_ratio: float | None
Operating cash flow ratio.
operating_cash_flow_sales_ratio: float | None
Operating cash flow to sales ratio.
free_cash_flow_operating_cash_flow_ratio: float | None
Free cash flow to operating cash flow ratio.
debt_service_coverage_ratio: float | None
Debt service coverage ratio.
interest_coverage_ratio: float | None
Interest coverage ratio.
short_term_operating_cash_flow_coverage_ratio: float | None
Short-term operating cash flow coverage ratio.
operating_cash_flow_coverage_ratio: float | None
Operating cash flow coverage ratio.
capital_expenditure_coverage_ratio: float | None
Capital expenditure coverage ratio.
dividend_paid_and_capex_coverage_ratio: float | None
Dividend paid and capital expenditure coverage ratio.
dividend_payout_ratio: float | None
Dividend payout ratio.
dividend_yield: float | None
Dividend yield.
dividend_per_share: float | None
Dividend per share.
revenue_per_share: float | None
Revenue per share.
net_income_per_share: float | None
Net income per share.
interest_debt_per_share: float | None
Interest-bearing debt per share.
cash_per_share: float | None
Cash per share.
book_value_per_share: float | None
Book value per share.
tangible_book_value_per_share: float | None
Tangible book value per share.
shareholders_equity_per_share: float | None
Shareholders' equity per share.
operating_cash_flow_per_share: float | None
Operating cash flow per share.
capex_per_share: float | None
Capital expenditure per share.
free_cash_flow_per_share: float | None
Free cash flow per share.
net_income_per_ebt: float | None
Net income per earnings before tax (EBT).
ebt_per_ebit: float | None
Earnings before tax (EBT) per earnings before interest and tax (EBIT).
price_to_fair_value: float | None
Price to fair value ratio.
debt_to_market_cap: float | None
Debt to market capitalization ratio.
effective_tax_rate: float | None
Effective tax rate.
enterprise_value_multiple: float | None
Enterprise value multiple (EV/EBITDA).
symbol: str | None
Symbol representing the entity requested in the data.
period_ending: date | None
The date of the data.
fiscal_period: str | None
Period of the financial ratios.
fiscal_year: int | None
Fiscal year.