Skip to main content
GET
Read exact-link available balances
Preview contract. Production availability remains subject to activation and release qualification. Examples are synthetic; the documentation cannot submit requests.

Authorization

read; link aggregates require an unrestricted instrument policy.

Behavior

Returns exact fixed-point free balances, link identity and snapshot_complete. An absent asset in an incomplete snapshot is not a zero balance. This HTTP model preserves decimal coefficients/scales and should be used for exact sizing reconciliation.

Request example

All IDs and dates are illustrative. URL-encode opaque query values and supply each allowed key once. Optional filters and their types appear in the generated schema below.

Response and errors

The generated response schema below is the wire contract. Preserve fixed-point strings, nullable fields and endpoint-specific envelopes. Inspect HTTP status and Content-Type before decoding failures; reused trading routes may return JSON or plain text. Authentication, entitlement and exact link/instrument restrictions apply in addition to endpoint validation. See errors and recovery. Read the related guide for lifecycle, units and recovery semantics.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

Required range: 1 <= x <= 9007199254740991

Response

Success

Required range: 1 <= x <= 9007199254740991
updates
object[]
required
snapshot_complete
boolean