Skip to content
Patrimoine
v9.1.0

Liquidity Endpoint

GET
/api/v1/charts/liquidity
curl --request GET \
  --url https://example.com/api/v1/charts/liquidity

Liquidity breakdown — funds grouped by availability horizon.

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
LiquidityResponse

Liquidity breakdown response — funds grouped by availability horizon.

object
total_assets
required
Total Assets
string
total_liabilities
required
Total Liabilities
string
net_worth
required
Net Worth
string
immediate_liquid
required
Immediate Liquid
string
immediate_pct
required
Immediate Pct
number
items
required
Items
Array<object>
LiquidityItem

Single liquidity horizon breakdown item.

object
horizon
required
Horizon
string
label
required
Label
string
total
required
Total
string
percentage
required
Percentage
number
account_count
required
Account Count
integer
emergency_fund_months
required
Any of:
number

Example generated

{
  "total_assets": "example",
  "total_liabilities": "example",
  "net_worth": "example",
  "immediate_liquid": "example",
  "immediate_pct": 1,
  "items": [
    {
      "horizon": "example",
      "label": "example",
      "total": "example",
      "percentage": 1,
      "account_count": 1
    }
  ],
  "emergency_fund_months": 1
}