GET
Get balances

Authorizations

Authorization
string
header
required

Master session from POST /v1/auth/verify. Revocable; expires after seven days by default. Required for financial operations.

Response

One entry per linked venue.

venue
string
required

A venue id from GET /v1/venues.

address
string
required

Responses are lowercase.

Pattern: ^0x[0-9a-fA-F]{40}$
venue_wallet
string | null
required

Null on venues without one.

equity
string | null
required

Base units; null before the first read.

withdrawable
string | null
required

Base units that can leave the venue margin.

withdrawable_estimated
boolean
required

True when the venue's public data gives only an upper bound; false while read_at is null. Per venue: Venues.

mode
string | null
required

Account mode on venues with several. Per venue: Venues.

has_account
boolean
required

False while the venue knows no account for the address; true while read_at is null.

wallet
string | null
required

Venue token held outside the margin, on venues with such a balance. Per venue: Venues.

chain_balance
string | null
required

Last observed token balance of the linked address on the escrow chain.

read_at
string<date-time> | null
required

Last successful venue read.

error
string | null
required

Why the last venue read failed; null on success.

chain_read_at
string<date-time> | null
required

RFC 3339 UTC; snapshots and history may keep fractional seconds.

chain_error
string | null
required