Sign in

v1

latestOpenAPI 3.0.02026-08-04134348905.1 KB
Vesting

Get vesting balances for multiple allocations

Get vesting balances for multiple allocation IDs in a single request. Returns per-allocation results with balance breakdowns including available, unvested, and locked amounts. Individual allocation errors are returned inline rather than failing the entire batch.

post/vesting/balances

Request body

allocationIdsstring[] required

List of allocation IDs to get vesting balances for

stakeholderIdstring

The external stakeholder ID (optional, used to retrieve wallet info when no transactions exist yet)

Response

Batch vesting balances for the requested allocations

errorCountinteger required

Number of allocations that failed

successCountinteger required

Number of allocations successfully processed

Example response

{
  "errorCount": 1,
  "results": [
    {
      "allocationId": "alloc-123",
      "balance": {
        "assetType": "BTC",
        "availableBalance": "1000.50000000",
        "externalTokenId": "magna_token_123",
        "lockedBalance": "100.10000000",
        "networkId": "ETHHOODI",
        "unvestedBalance": "500.25000000"
      },
      "walletInfo": {
        "address": "0x1234567890abcdef...",
        "walletId": "3d293c0d64c703023692216e9b4f5280"
      }
    }
  ],
  "successCount": 3
}