Investors, warrants & staking

Get Available Staking Balance

Computes how many tokens of a grant the caller can still stake, honouring vesting, lockups and grace period.

GEThttps://api.toku.com/tga/get-available-staking-balance

Not available to API keys.

curl --request GET \
  --url 'https://api.toku.com/tga/get-available-staking-balance?grantID=%3CgrantID%3E' \
  --header 'Authorization: Bearer <token>'
200 response
{
  "availableBalance": "string",
  "vestedAmount": "string",
  "unvestedAmount": "string",
  "lockedAmount": "string",
  "unlockedAmount": "string",
  "isLocked": true,
  "stakeableAmount": "string",
  "maxStakePercentage": "string",
  "alreadyStaked": "string",
  "enabledStakingTypes": [
    "VESTED_LOCKED_TOKENS"
  ],
  "typeAmounts": {
    "VESTED_LOCKED_TOKENS": "string",
    "UNVESTED_LOCKED_TOKENS": "string",
    "UNVESTED_UNLOCKED_TOKENS": "string"
  },
  "message": "string"
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is an access token from a Toku sign-in. See Authentication in the API reference.

Query parameters

grantIDstring<uuid>required

Response

200Successful response
availableBalancestringrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

vestedAmountstringrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

unvestedAmountstringrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

lockedAmountstringrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

unlockedAmountstringrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

isLockedbooleanrequired
stakeableAmountstringrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

maxStakePercentagestringrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

alreadyStakedstringrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

enabledStakingTypesstring[]required
typeAmountsobjectrequired
Show child attributes
VESTED_LOCKED_TOKENSstringrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

UNVESTED_LOCKED_TOKENSstringrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

UNVESTED_UNLOCKED_TOKENSstringrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

messagestringrequired
400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits