Skip to main content
GET
Get account balances (bulk, reconciliation-friendly)

Authorizations

X-API-Key
string
header
required

Organization API key (hp_live_...), sent in the X-API-Key header. Create, rotate and restrict keys in the dashboard or with the API keys endpoints; an organization can have two active keys, so you can rotate without downtime. A full-access key can call every endpoint in this reference. A read-only key can call GET endpoints (and create a trading stream token); any other request returns 403 READ_ONLY_KEY. A key with an IP allowlist returns 403 IP_NOT_ALLOWED from any other address. Each endpoint lists which keys can call it under Access.

Query Parameters

accountId
string

Scope to specific accounts: one account UUID or a comma-separated list (max 200). Every ID must belong to your organization, otherwise 404 ACCOUNT_NOT_FOUND.

customerId
string

Exact match on the customerId you set at account creation — all balances for one of your customers.

Maximum string length: 255
status
enum<string>

Filter by account status

Available options:
not_started,
in_progress,
inactive,
passed,
failed,
expired
updatedSince
string

Only accounts whose balance or state changed at or after this instant (ISO 8601), including the daily baseline roll at the close. Use the asOf value from your previous response to fetch just what moved since then.

limit
integer
default:100

Results per page (default: 100, max: 500)

Required range: 1 <= x <= 500
offset
integer
default:0

Skip this many results (for pagination)

Required range: x >= 0
cursor
string

Cursor for pagination. Pass the nextCursor value from the previous response to get the next page. When using cursor, do not send offset — it will be ignored.

How it works: The cursor is an opaque string that points to the last item you received. The server uses it to efficiently fetch the next set of results without scanning previous pages.

Backwards compatible: If you don't send a cursor, offset/limit pagination works as before.

A cursor that was not returned by this endpoint, or one from a request with a different sort, is rejected with 400.

Maximum string length: 512

Response

Success - Returns one balance row per account

success
boolean
Example:

true

data
object
Example: