Analytics: Get financial ratios
get_financial_ratios Get key financial ratios computed from the user's data.
Returns pre-computed ratios.
Three different "debt-to-income" flavors are returned and they are
not interchangeable; each fits a different use case:
Returns:
- savings_rate_pct: (income - expenses) / income * 100
- expense_ratio_pct: expenses / income * 100
- debt_to_income_ratio: BALANCE-SHEET LEVERAGE RATIO —
total liabilities / annual income, as a multiple (e.g. 2.36).
A normal homeowner sits above 1.0 because mortgage balance
dwarfs annual income; that's expected for this metric and
NOT a sign of financial trouble. Suited to net-worth analysis.
- back_end_dti_pct: MORTGAGE-INDUSTRY BACK-END DTI —
monthly debt service / monthly gross income, as a percent.
28% / 36% are the GSE qualifying-mortgage thresholds. Same
calc the health-score DTI component uses. None when no
debt accounts have ``minimum_payment`` populated.
- front_end_dti_pct: MORTGAGE-INDUSTRY FRONT-END DTI —
housing payment (mortgage P&I + escrow tax + escrow
insurance) / monthly gross income, as a percent. 28% is
the standard threshold. None when the user has no mortgage
accounts. Measures housing affordability, as opposed to
the "all debt" back-end view.
- monthly_debt_service: dollar sum of minimum payments across
active debt accounts (numerator of back_end_dti_pct).
- monthly_housing_payment: dollar sum of mortgage P&I + escrow
across active mortgage accounts (numerator of front_end_dti_pct).
- emergency_fund_months: liquid assets / monthly expenses
- credit_utilization_pct: CC balances / CC limits * 100
- financial_assets / financial_net_worth: FINANCIAL-ONLY view
(excludes hard assets like real estate, vehicles, jewelry).
These differ from the consumer-facing net worth and balance
sheet figures, which *include* hard assets and match the
dashboard.
- Plus: total_liabilities, annual income/expenses
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||