The Tokens API (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.
https://tokens.shakesco.com) lets your backend interact with the Shakesco managed token contracts on Polygon. Customers hold loyalty tokens by email with no crypto wallet required.
Authentication
All requests require your API key in theAuthorization header. The API resolves your key to your business token contract automatically.
Generate your API key at users.shakesco.com/user/api-tokens
How It Works
- Customers are identified by email. You never handle private keys.
- All write operations are submitted as on-chain transactions and return a
tx_hash. - Read operations return data directly from the contract state.
Base URL
Endpoint Groups
Rewards
Claim, redeem, expire tokens and award pending rewards
Transfer
Transfer tokens between users or migrate from another system
Staking
Lock tokens into stakes and collect staking rewards
Vesting
Create, claim, and cancel vesting grants
Promotions
Run happy hours and set daily earning caps
Governance & Cashback
Configure tiers, voting ratios, and cashback programs
Read & Query
Check balances, user info, and activity
Events
Manage token claim events on your BusinessToken contract
Common Error Codes
| Code | Error | Meaning |
|---|---|---|
| 400 | Invalid parameters | Check field types and values |
| 400 | Insufficient token balance | Customer does not have enough tokens |
| 400 | No tokens are claimable | Vesting schedule has nothing to claim yet |
| 401 | Unauthorized | Missing or invalid API key |
| 403 | Caller not authorized | Your key is not linked to this contract |
| 404 | Event not found | Event name does not exist on the contract |
| 409 | Event already claimed | Customer already claimed a one-time event |
| 409 | Stake already unlocked | Cannot unstake an already-unlocked position |
| 429 | Daily earning cap exceeded | Customer hit the daily token earning limit |
| 429 | Fee limit exceeded | Your API compute budget is exhausted |
| 502 | On-chain transaction failed | Blockchain reverted, check contract state |