Participants

Get participant balances

Returns current balances for a participant, broken down by bucket. Balances are computed, so this list does not accept created_after or created_before.

get/v1/participants/{participant_id}/balances

Request

  • Base URL: https://api.scrip.dev
  • URL: https://api.scrip.dev/v1/participants/{participant_id}/balances
  • Auth: HTTP bearer

Path parameters

participant_idstring required

The participant's id, or ext: followed by the participant's external_id.

Query parameters

asset_idstring uuid

Filter to a specific asset

Response

Balances for matching assets

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.