---
title: "Get group balances"
method: GET
path: "/v1/groups/{group_id}/balances"
tags: ["Groups"]
---

# Get group balances

`GET /v1/groups/{group_id}/balances`

## Request

- Base URL: `https://api.scrip.dev`
- URL: `https://api.scrip.dev/v1/groups/{group_id}/balances`
- Auth: HTTP bearer

Returns the group's `available`, `held`, and `deferred` amounts for each asset.
Balances are computed, so this list does not accept created_after or created_before.

## Path parameters

- `group_id` string, uuid, required

## Query parameters

- `program_id` string, uuid

## Response `200`

Group balances

- GroupAssetBalanceListResponse: One page of a group's balances, one row per asset, with pagination.
  - `data` Balance[]: One entry per asset the group holds
    - `asset_id` string, uuid: Asset the balance is in.
    - `available` string: Amount in the available bucket. For a `LOT` asset, it can include value past its `expires_at` for a few minutes, until Scrip records the expiration.
    - `deferred` string: Amount that becomes available when its `matures_at` time passes.
    - `held` string: Amount set aside by a hold or waiting as pending rewards; it cannot be spent until it is released or settled.
  - `pagination` PaginationResponse: Cursor details for a list. `has_more` says whether another page exists, and `next_cursor` is the value to send to get it.
    - `has_more` boolean, required: Whether more results are available beyond this page
    - `next_cursor` string, nullable, required: Cursor to fetch the next page. Null on the last page

## Other responses

- `400`: Invalid parameters (code: validation_error)
- `401`: The API key is missing or not valid. See [Authentication](https://docs.scrip.dev/authentication).
- `404`: Group not found (code: group_not_found)
- `429`: Too many requests. Wait the number of seconds in the `Retry-After` header, then retry. See [Limits and durations](https://docs.scrip.dev/limits#rate-limits).
- `500`: Something failed on Scrip's side. Retry the request, and quote `request_id` if it keeps failing. [Errors](https://docs.scrip.dev/errors) lists every code, and the [API introduction](https://docs.scrip.dev/api-reference/introduction) describes the error format.

---

[API](https://skmtc.dev/scrip/apis/scrip-api.md) · [All operations](https://skmtc.dev/scrip/apis/scrip-api/llms.txt) · [OpenAPI document](https://skmtc.dev/scrip/apis/scrip-api/revisions/c52d35da8d97?raw)
