Skip to main content
GET
/
wealth
/
accounts
/
{account_id}
/
financial-plan
/
summary
Get financial health summary
curl --request GET \
  --url https://api.bluumfinance.com/v1/wealth/accounts/{account_id}/financial-plan/summary \
  --header 'Authorization: Basic <encoded-value>'
{
  "financial_plan_id": "fp_a1b2c3d4e5f6",
  "total_net_worth": "275000.00",
  "total_assets": "625000.00",
  "total_liabilities": "350000.00",
  "total_goal_progress": "35.00",
  "goals_on_track": 3,
  "goals_at_risk": 1,
  "monthly_cash_flow": "4000.00",
  "savings_rate": "33.33",
  "investment_portfolio_value": "125000.00",
  "generated_at": "2025-01-15T16:00:00Z"
}

Authorizations

​
Authorization
string
header
required

HTTP Basic Authentication using the API Key as username and API Secret as password.

Path Parameters

​
account_id
string<uuid>
required

The investor account ID

Response

Financial health summary retrieved successfully

Summary of financial health

​
financial_plan_id
string<uuid>
​
currency
string

ISO 4217 currency code for all monetary values in this summary

Example:

"USD"

​
total_net_worth
string

Total net worth (assets - liabilities)

​
total_assets
string
​
total_liabilities
string
​
total_goal_progress
string

Overall progress across all goals (percentage)

​
goals_on_track
integer

Number of goals on track

​
goals_at_risk
integer

Number of goals at risk

​
monthly_cash_flow
string

Monthly income minus expenses

​
savings_rate
string

Percentage of income being saved/invested

​
investment_portfolio_value
string

Total value of investment portfolios

​
generated_at
string<date-time>