Skip to main content
GET
/
stake-info
Get Stake Info
curl --request GET \
  --url https://tokens.shakesco.com/stake-info \
  --header 'Authorization: Bearer <token>'
{
  "amount": "100.0",
  "start_time": "1715000000",
  "lock_duration": "2592000",
  "reward_percent": 5,
  "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 principal, start time, lock duration, reward percent, and active flag for a specific stake. Indexes are 0-based and correspond to creation order; use /stake-count to find the highest valid index. If the index doesn’t exist for this customer, the endpoint returns zeros and active: false rather than an error.

Query Parameters

customer_ref
string
required
Your unique identifier for this customer
stake_index
integer
required
0-based index of the stake position

Response

amount
string
Principal locked in the stake
start_time
string
Unix timestamp (seconds) when the stake was created
lock_duration
string
Configured lock period in seconds
reward_percent
number
Reward percent earned at full lock period
active
boolean
true if the stake is still locked; false once unstaked
const res = await fetch(
  "https://tokens.shakesco.com/stake-info?customer_ref=customer-123&stake_index=0",
  { headers: { Authorization: `Bearer ${API_KEY}` } }
);
const stake = await res.json();
{
  "amount": "100.0",
  "start_time": "1715000000",
  "lock_duration": "2592000",
  "reward_percent": 5,
  "active": true
}