Skip to main content
GET
Get balances

Integration guide

Authorizations

x-app-id
string
header
required

Your application ID. Required on app-tier and user-tier routes. Omitted on routes that authenticate with x-app-api-key only.

Authorization
string
header
required

JWT access token from POST /auth/verify. Required with x-app-id on user routes. On the smart-route quote it is optional and turns a preview into an executable quote.

Query Parameters

mode
enum<string>
Available options:
live,
paper
custody
enum<string>
Available options:
managed,
self

Response

200

cash
object[]
required

Stablecoin cash, one entry per token, with per-chain rows.

positions
object[]
required

Value of open positions, one entry per venue.

venueCash
object[]

Cash held inside venue accounts, separate from on-chain cash. Omitted when no such venue is available.

paper
object

Paper-account summary. Present only in paper mode.