Skip to main content
GET
/
stake-rewards
Get Stake Rewards
curl --request GET \
  --url https://tokens.shakesco.com/stake-rewards \
  --header 'Authorization: Bearer <token>'
{ "rewards": "1.5" }

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 rewards that have accrued on a specific stake up to right now. This is the amount that would be paid out if the customer unstaked immediately. Returns "0" if the stake has already been unstaked or doesn’t exist.

Query Parameters

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

Response

rewards
string
Accrued reward tokens (decimal string)
const res = await fetch(
  "https://tokens.shakesco.com/stake-rewards?customer_ref=customer-123&stake_index=0",
  { headers: { Authorization: `Bearer ${API_KEY}` } }
);
const { rewards } = await res.json();
{ "rewards": "1.5" }