Keys belong to a club, not to a person. A key can read that club and nothing else. Club owners manage keys, whatever their membership role, and any club can create them.
Create a key
- Open the Superstat app and go to
Settings. - In
API keys, enter a name, for exampleClub website. - Choose how the key will be used: a public website or app, private or internal use, or development and testing.
- For a public website or app, enter the URL where Superstat data will be shown. Private and development keys do not need one.
- Choose Create key.
- Copy the secret. It starts with
ss_live_and is shown only once.
You can change the use case and the public URL later from the same list. Saving a URL records where you intend to show the data. It does not confirm that the page credits Superstat.
The list in Settings keeps the name and a short prefix such as ss_live_a1b2c3d4 so you can tell keys apart. It never shows the full secret again. A club can have up to 20 active keys.
Send the key
Pass the secret as a bearer token on every request:
curl https://api.superstatsport.com/v1/clubs \
-H "Authorization: Bearer ss_live_your_secret"An X-Api-Key: ss_live_your_secret header is accepted as well.
Keep the key on a server. Do not ship it in a mobile app or in browser code, where anyone could read it.
Revoke a key
In Settings → API keys, choose Revoke next to the key. Requests that still use it fail with 401 straight away. Revoked keys stay in the list with the date they were turned off.
Try it
Every endpoint page in the API reference has a Send request button that sends the request from your browser. Add your key as the bearer token to use it.
Public pages
If the system that uses the key shows Superstat data to people outside your club, credit Superstat beside that data. See Attribution. The wording there is proposed guidance, not a binding term yet.
