Reference
API
Reading your server's data with an API token.
The Spire API lets your own website or bot read your server's data. It can only read. Nothing you do with it can change your server, punish anyone or start a session.
Making a token
Open your dashboard, go to API tokens and make one. Pick what it can read. Spire shows the token once, then only keeps a fingerprint of it, so copy it somewhere safe. If a token leaks, delete it and make a new one.
Free servers can have one token. Servers with Spire Plus can have ten.
Sending requests
Send the token in the Authorization header:
curl https://usespire.xyz/api/v1/server \
-H "Authorization: Bearer spire_your_token"
Every response is JSON, with what you asked for under data and how many requests you have left this minute under rate. Errors look like {"error": "What went wrong"} with a 4xx status.
Limits
Each token can make 20 requests a minute, or 60 with Spire Plus. Go over and you get a 429, with retry_after saying how many seconds to wait. Live data like player counts only changes every few seconds, so there's no point asking more often than that.
Endpoints
GET /api/v1/server | Name, online or offline, players, max players, queue length, join code and staff in game. |
GET /api/v1/players | Who's in game, with their Roblox ID, team, callsign and time in game. |
GET /api/v1/staff | Staff in game and staff on shift. |
GET /api/v1/logs | The 50 most recent punishment logs. |
GET /api/v1/shifts | Shift time per staff member over the last 7 days, in seconds. |
GET /api/v1/sessions | The last 20 sessions, when they started and ended, and their peak player count. |
GET /api/v1/members | Spire members and their roles. |
A token can only call the endpoints you ticked when you made it. Calling one it can't use gives a 403.
From a browser
The API allows requests from any website, but anyone can read a token you put in a web page. Call it from your own server instead and keep the token there.