How do I get an API token and read my club's data?
Create a read-only token at Settings > API access, send it as a Bearer header, and read your club's published events and tournaments.
Posted Last updated Last reviewed
Use a token when your own website, scoreboard or app needs to read your club's data. To only show events or standings on a page, an embed is simpler.
Steps
- Open Settings in the Organizer sidebar and choose API access. Only officers who can edit club settings see it.
- Under New token, enter a Name, such as Club scoreboard.
- Open More options. Under What it can read, tick Events, Tournaments or both, and set Requests a minute (60 by default, 1 to 600).
- Press Create token and copy it with Copy token straight away. It is shown only once; press I have saved it when done.
- Send it on every request, for example
curl -H "Authorization: Bearer $CHESSOS_TOKEN" <api address>/v1/tournaments. The full address and the reference are on the developers page.
Good to know
- Each token in the list shows its prefix, scopes, limit and when it was last used. Rename or change limit, Rotate (the old token stops at once) or Revoke it. Creating and revoking are recorded in the audit log.
- Tokens are read-only and read only your own club's published events and tournaments, never members, contact details, dates of birth or guardians.
- Over the limit the API answers 429 with a
Retry-Afterheader. Responses may be cached for 15 seconds. - Make one token per tool, so you can revoke a single scoreboard without breaking your website.