Skip to main content
GET
/
v1
/
programs
/
{id}
/
balance
Get program balance
curl --request GET \
  --url https://api.scrip.dev/v1/programs/{id}/balance \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "asset_id": "550e8400-e29b-41d4-a716-446655440000",
      "available": "10000.00",
      "deferred": "0.00",
      "held": "0.00",
      "issuance_policy": "PREFUNDED"
    }
  ],
  "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 the current wallet balance for each asset linked to the program. The balance reflects the net of fund and burn operations minus credits issued by rules. Only meaningful for assets with an issuance_policy of PREFUNDED. UNLIMITED assets bypass the wallet entirely and do not appear here. Use this to monitor remaining budget; when a PREFUNDED wallet reaches zero, credits fail.
For usage patterns and examples, see the Programs guide.

Authorizations

​
X-API-Key
string
header
required

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

Path Parameters

​
id
string<uuid>
required

Program ID

Query Parameters

​
asset_id
string<uuid>

Return balance for a single asset

​
limit
integer
default:50

Maximum number of results (default 50, max 200)

Required range: x >= 1
​
cursor
string

Pagination cursor from previous response

Response

Program balances

​
data
object[]

Data contains the list of items

​
pagination
object

Pagination contains cursor information for fetching more results