API reference
Read endpoints are open and return JSON. Please keep to a request a minute per ladder; the numbers change at most every 10 minutes, and answers are cached for a minute.
Ladder standings
curl https://chessclubladder.com/api/ladder/demo-club?period=30
period: 7, 30 or season. Returns the ladder, standings.players[] with pools.li and pools.cc per time control (now, from, change, games, prov, sinceJoin), the week to date and recent awards.
One player
curl https://chessclubladder.com/api/ladder/demo-club/player/1
Last 7 and 30 days, rating history per site and pool ([day, rating], day = days since 1970-01-01 UTC), activity and benchmarks.
Public ladders
curl https://chessclubladder.com/api/ladders
Comparison and benchmarks
curl https://chessclubladder.com/api/compare
Downloads (Club pass)
CSV or JSON of a ladder's standings, with the admin token or your license key:
curl -H "Authorization: Bearer YOUR-LICENSE-KEY" "https://chessclubladder.com/api/ladder/<ladder>/admin/export?format=csv&period=30" -o ladder.csv
Errors
Errors return JSON {"error": "..."} with a 4xx or 5xx status: 404 for an unknown ladder, 402 for a Club pass feature, 429 when you're going too fast.