Penny Docs
Historical balances

List Historical Balances

GET
/v1/households/{household_id}/historical-balances

Retrieves daily balance history for the household, optionally restricted to specific accounts and an inclusive date range. Daily totals use the household's reporting currency; per-account balances retain their native currencies.

Missing daily values carry forward the last known balance and are marked is_interpolated. Closed accounts contribute zero from their closure date, and deleted accounts are excluded. Without date bounds, history runs from the first recorded balance through today in the household's timezone. A supplied end date is capped at tomorrow. The response also includes first-balance and account-closure events.

Authorization

PersonalApiToken
AuthorizationBearer <token>

Use your personal API token (penny_pat_…) as the bearer credential. Enter the token only; the client adds the Bearer prefix. Read-only tokens permit read requests. Read/write tokens remain limited by your current household membership and role. See https://penny.finance/docs/api#authentication for setup.

In: header

Path Parameters

household_id*Household Id

Query Parameters

start_date?|null
end_date?|null
account_ids?array<string>|null

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/households/string/historical-balances"
{  "balances": [    {      "date": "2019-08-24",      "balance": {        "amount": "68.42",        "currency": "USD"      },      "accounts": [        {          "account_id": "Ac7kP2mN9qRs",          "balance": {            "amount": "68.42",            "currency": "USD"          },          "is_interpolated": true        }      ]    }  ],  "events": [    {      "date": "2019-08-24",      "account_id": "Ac7kP2mN9qRs",      "account_name": "Everyday Checking",      "type": "first_balance"    }  ]}