assetsGet the net-worth summary

Get the net-worth summary

Unavailable (data-excluded) for connections that exclude accounts: net worth is served from a stored snapshot that cannot be retro-filtered by account. Category exclusions do not affect net worth and are served normally.

curl -X GET "https://api.403fin.io/v1/net-worth" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "X-API-Key: YOUR_API_KEY"
{
  "data": {
    "net_worth": "example_string",
    "total_assets": "example_string",
    "total_liabilities": "example_string",
    "base_currency": "example_string",
    "snapshot_date": "2024-12-25",
    "is_manual": true,
    "liquid_net_worth": "example_string",
    "investable_net_worth": "example_string",
    "breakdown": {
      "liquidity": {
        "liquid": "example_string",
        "investable": "example_string",
        "illiquid": "example_string"
      },
      "by_asset_type": [
        {
          "label": "example_string",
          "value": "example_string",
          "percentage": 3.14,
          "day_change_amount": "example_string",
          "day_change_pct": "example_string"
        }
      ],
      "by_currency": [
        {
          "label": "example_string",
          "value": "example_string",
          "percentage": 3.14,
          "day_change_amount": "example_string",
          "day_change_pct": "example_string"
        }
      ],
      "by_retirement_subtype": [
        {
          "label": "example_string",
          "value": "example_string",
          "percentage": 3.14,
          "day_change_amount": "example_string",
          "day_change_pct": "example_string"
        }
      ]
    },
    "computed_at": "2024-12-25T10:00:00Z"
  },
  "pagination": {
    "next_cursor": "example_string",
    "has_more": true
  },
  "redacted_fields": [
    "example_string"
  ],
  "filtered": true
}
GET
/v1/net-worth
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

An opaque ff_ credential (ff_ak_ / ff_at_) presented as a Bearer token.

An opaque ff_ credential (ff_ak_ / ff_at_) presented as a Bearer token.
API Key (header: X-API-Key)
X-API-Keystring
Required

An opaque ff_ credential presented in the X-API-Key header.

An opaque ff_ credential presented in the X-API-Key header.
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. An opaque ff_ credential (ff_ak_ / ff_at_) presented as a Bearer token.

header
X-API-Keystring
Required

API Key for authentication. An opaque ff_ credential presented in the X-API-Key header.

Responses

dataobject
Required
paginationstring

Cursor pagination state, present on list endpoints.

redacted_fieldsstring[]

Field ids stripped from the payload by connection scope.

filteredboolean

True when row or aggregate filtering is in effect for this response.