Skip to content
Purser

Balance Series

GET
/accounts/{account_id}/balance/series
curl --request GET \
  --url https://example.com/accounts/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/balance/series

Balance history for one account over [start, end], one point per transaction that moved it, plus the opening balance carried into the window.

REST is not token-budgeted, so this is the full per-change series — the downsampled, narrated form is MCP balance_history. Both compose on the same service functions, so they can never disagree. truncated is set rather than silently dropping the tail past 5000 points.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
account_id
required
Account Id
string format: uuid

Query Parameters

Section titled “Query Parameters”
start
Any of:
string format: date

Defaults to end - 90d

end
Any of:
string format: date

Defaults to today (UTC)

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
BalanceSeries

Full-resolution balance history: one point per stored change, which is the grain the running-balance store keeps and the register shows.

object
account_id
required
Account Id
string format: uuid
currency
required
Currency
string
end
required
End
string format: date
method
required
Method
string
opening
required
Opening
string
path
required
Path
string
points
required
Points
Array<object>
BalancePoint
object
balance
required
Balance
string
date
required
Date
string format: date
delta
required
Delta
string
transaction_id
required
Transaction Id
string format: uuid
start
required
Start
string format: date
truncated
required
Truncated
boolean

Example generated

{
  "account_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "currency": "example",
  "end": "2026-04-15",
  "method": "example",
  "opening": "example",
  "path": "example",
  "points": [
    {
      "balance": "example",
      "date": "2026-04-15",
      "delta": "example",
      "transaction_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
    }
  ],
  "start": "2026-04-15",
  "truncated": true
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string

Example generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}