Vesting

Get vesting balances for an allocation

Get vesting balances for a specific allocation ID. Returns the current balance breakdown including available, unvested, and locked amounts.

get/vesting/balances/{allocationId}

Request

Base URL
https://api.anchorage-staging.com/v2
Auth
API key in header Api-Access-Key
TypeScript
https://skmtc.dev/anchorage/apis/anchorage-digital-api-reference/docs/vesting/balances/:allocationId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

allocationIdstring required

The ID of the allocation to get vesting balances for

Query parameters

stakeholderIdstring

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

Response

Vesting balances for the specified allocation

Example response

{
  "balance": {
    "assetType": "BTC",
    "availableBalance": "1000.50000000",
    "externalTokenId": "magna_token_123",
    "lockedBalance": "100.10000000",
    "networkId": "ETHHOODI",
    "unvestedBalance": "500.25000000"
  },
  "walletInfo": {
    "address": "0x1234567890abcdef...",
    "walletId": "3d293c0d64c703023692216e9b4f5280"
  }
}

Changes

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