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",
      "issuance_policy": "PREFUNDED"
    }
  ],
  "pagination": {
    "has_more": true,
    "next_cursor": "YWJjMTIz"
  }
}
Returns the current wallet balance for each asset linked to the program. The balance reflects the net of all fund and burn operations minus credits that have been issued by rules. This endpoint is only meaningful for assets with an issuance_policy of PREFUNDED. Assets set to UNLIMITED bypass the wallet entirely and will not appear with a usable balance here. Use this to monitor remaining budget before it runs out and starts rejecting credits.
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