Skip to main content
GET
/
vested-amount
Vested Amount
curl --request GET \
  --url https://tokens.shakesco.com/vested-amount \
  --header 'Authorization: Bearer <token>'
{ "vested_amount": "125.0" }

Documentation Index

Fetch the complete documentation index at: https://docs.shakesco.com/llms.txt

Use this file to discover all available pages before exploring further.

For the complete documentation index, see llms.txt. Returns how many tokens are vested but not yet claimed for this customer. This is the amount /claim-vested-tokens would move into available balance if called right now. Returns "0" if there’s no active grant or nothing has vested yet.

Query Parameters

customer_ref
string
required
Your unique identifier for this customer

Response

vested_amount
string
Tokens currently claimable
const res = await fetch(
  "https://tokens.shakesco.com/vested-amount?customer_ref=customer-123",
  { headers: { Authorization: `Bearer ${API_KEY}` } }
);
const { vested_amount } = await res.json();
{ "vested_amount": "125.0" }