Skip to main content
GET
/
v1
/
participants
/
{id}
/
balances
Get participant balances
curl --request GET \
  --url https://api.scrip.dev/v1/participants/{id}/balances \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "asset_id": "550e8400-e29b-41d4-a716-446655440000",
      "available": "1500.00",
      "deferred": "0.00",
      "held": "200.00"
    }
  ],
  "pagination": {
    "has_more": true,
    "next_cursor": "YWJjMTIz"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.scrip.dev/llms.txt

Use this file to discover all available pages before exploring further.

Returns balances for all assets held by a participant. Each asset’s balance is split into two buckets:
  • available: funds the participant can spend
  • held: funds reserved by hold operations (e.g. pending settlements, fraud review). Not spendable until released
The sum of available and held 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