Skip to main content
GET
Get participant balances
Returns balances for all assets held by a participant. Each asset’s balance is split into three buckets:
  • available: funds the participant can spend
  • held: funds reserved by hold operations (e.g. pending settlements, fraud review). Not spendable until released
  • deferred: funds credited with a future matures_at date. They move to available automatically when the date passes
The sum of available, held, and deferred gives the participant’s total balance for a given asset.
For usage patterns and examples, see the Balance Operations guide.

Authorizations

X-API-Key
string
header
required

API key passed in the X-API-Key header.

Path Parameters

id
string<uuid>
required

Participant ID

Query Parameters

asset_id
string<uuid>

Filter to a specific asset

Response

Balances for matching assets

data
object[]

Balance entries by asset

pagination
object

Pagination metadata for list responses