Skip to main content
GET
/
vesting-info
Get Vesting Info
curl --request GET \
  --url https://tokens.shakesco.com/vesting-info \
  --header 'Authorization: Bearer <token>'
{
  "total_amount": "1000.0",
  "start_time": "1715000000",
  "cliff_duration": "7776000",
  "cliff_percent": 25,
  "vesting_duration": "31536000",
  "claimed": "250.0",
  "active": true
}

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 the configuration of a customer’s vesting grant, including how much has already been claimed and whether it’s still active.

​
Query Parameters

​
customer_ref
string
required
Your unique identifier for this customer

​
Response

​
total_amount
string
Total tokens in the grant
​
start_time
string
Unix timestamp (seconds) when the grant was created
​
cliff_duration
string
Configured cliff period in seconds
​
cliff_percent
number
Percent unlocked at the cliff
​
vesting_duration
string
Total vesting period in seconds
​
claimed
string
Tokens the customer has already claimed
​
active
boolean
false once the grant is fully claimed or cancelled
const res = await fetch(
  "https://tokens.shakesco.com/vesting-info?customer_ref=customer-123",
  { headers: { Authorization: `Bearer ${API_KEY}` } }
);
const grant = await res.json();

{
  "total_amount": "1000.0",
  "start_time": "1715000000",
  "cliff_duration": "7776000",
  "cliff_percent": 25,
  "vesting_duration": "31536000",
  "claimed": "250.0",
  "active": true
}