Groups

Get group balances

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.

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

Path parameters

group_idstring uuid required

The group's id.

Query parameters

program_idstring uuid

Filter by program ID

Response

Group balances

Example response

{
  "data": [
    {
      "asset_id": "a3bb189e-8bf9-4c8b-9be0-6b5d2f4e7a02",
      "available": "1500.00",
      "deferred": "0.00",
      "held": "200.00"
    }
  ],
  "pagination": {
    "has_more": true,
    "next_cursor": "YWJjMTIz"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.