---
title: "Get net worth history"
method: POST
path: "/v1/tools/betteroff_get_net_worth_history"
tags: ["tools"]
---

# Get net worth history

`POST /v1/tools/betteroff_get_net_worth_history`

## Request

- Base URL: `https://api.betteroff.finance`
- URL: `https://api.betteroff.finance/v1/tools/betteroff_get_net_worth_history`
- Auth: one of:
  - OpenID Connect (`https://app.betteroff.finance/api/auth/.well-known/openid-configuration`, scopes: `networth:read`)
  - HTTP bearer

Use this when the user asks how net worth changed over time. Read stored household valuations over time, paged by cursor. For a two-date explanation use betteroff_explain_net_worth_change.

## Request body

- object
  - `period` '7d' | '30d' | '90d' | 'all', nullable, required: Time period for the trend. Use '7d' for last week, '30d' for last month, '90d' for last quarter, 'all' for all history, or null for '30d'.
  - `cursor` object, nullable
    - `offset` integer, required
    - `revision` integer, required
  - `limit` integer, nullable

## Response `200`

Tool result

- union
  - object
    - `ok` false, required
    - `requestId` string
    - `error` string, required
    - `code` string, required
    - `retryable` boolean, required
    - `nextStep` string, required
    - `field` string
    - `missingInputs` object[]
      - `id` string, required
      - `name` string, required
      - `balanceMissing` boolean, required
      - `interestRateMissing` boolean, required
      - `minimumPaymentMissing` boolean, required
  - object
    - `ok` true, required
    - `requestId` string
    - `schemaVersion` '4', required
    - `data` object, required
      - `period` '7d' | '30d' | '90d' | 'all', required
      - `dataPoints` object[], required
        - `id` string, uuid, required
        - `date` string, required
        - `netWorth` string, required: Decimal text, e.g. "-12.50". Read the currency beside it or on the result.
        - `currency` string, required
        - `reconciliationStatus` string, required
      - `change` string, nullable, required: Decimal text, e.g. "-12.50". Read the currency beside it or on the result.
      - `changePercent` number, nullable
      - `asOf` string, nullable
      - `baseDate` string
      - `baseNetWorth` string: Decimal text, e.g. "-12.50". Read the currency beside it or on the result.
      - `baseCurrency` string
      - `currentNetWorth` string: Decimal text, e.g. "-12.50". Read the currency beside it or on the result.
      - `totalAssets` string: Decimal text, e.g. "-12.50". Read the currency beside it or on the result.
      - `totalLiabilities` string: Decimal text, e.g. "-12.50". Read the currency beside it or on the result.
    - `currency` string, nullable, required
    - `timezone` string, required
    - `asOf` string, nullable, required
    - `revision` integer, required
    - `householdRevision` integer, required
    - `quality` object, required
      - `state` 'complete' | 'partial' | 'unavailable', required
      - `reasons` string[], required
    - `evidence` object[], required
      - `source` string, required
      - `id` string
      - `observedAt` string, nullable, required
    - `page` object, required
      - `returnedCount` integer, required
      - `totalCount` integer, nullable, required
      - `truncated` boolean, required
      - `nextCursor` Schema0, required (unresolved $ref)
    - `warnings` string[], required
    - `notes` string

## Other responses

- `400`: INVALID_INPUT (a missing, unknown, or invalid argument, named in `fields`), TOOL_CALL_REJECTED, or a body that is not JSON.
- `401`: AGENT_TOKEN_INVALID: the token is missing, expired, or revoked.
- `402`: AGENT_SUBSCRIPTION_INACTIVE or FEATURE_NOT_INCLUDED: needs BetterOff Core.
- `403`: INSUFFICIENT_SCOPE, ACCESS_DENIED, or AGENT_GRANT_REVOKED.
- `404`: TOOL_NOT_FOUND, or NOT_FOUND for a record the org does not have.
- `409`: CONFLICT: the record's state rules this call out. Read it again.
- `422`: INCOMPLETE_DATA or RESULT_TOO_LARGE. Narrow the request; don't retry as is.
- `429`: RATE_LIMITED. Retry after Retry-After seconds.
- `503`: DATA_UNAVAILABLE, DEPENDENCY_UNAVAILABLE (including the 25-second tool deadline), or AGENT_AUTHZ_UNAVAILABLE. Retryable.
- `default`: Problem details

---

[API](https://skmtc.dev/betteroff/apis/betteroff-api.md) · [All operations](https://skmtc.dev/betteroff/apis/betteroff-api/llms.txt) · [OpenAPI document](https://skmtc.dev/betteroff/apis/betteroff-api/revisions/bc858c8d428d?raw)