# API
The server exposes a smattering of small HTTP API endpoints for use in your programs. All of these endpoints are
accessible via https://api.sc3.io/v3/
. All requests return a JSON response.
# /v3/players
Returns the number of players online, and the number of players currently active.
{
"total": 10, // Total number of players online
"active": 7 // Number of players currently active (not AFK or bots)
}
# /v3/tps
Returns the current TPS of the server.
{
"tps": 20.0, // The ticks per second, averaged over the last 100 ticks
"avgMsPerTick": 1.592209, // The time per tick, in milliseconds, averaged over the last 100 ticks
"lastMsPerTick": 1.2700219 // The time per tick, in milliseconds, for the last tick
}
# /v3/activetime
Returns the top 50 most active players on the server, excluding players who have opted out.
{
"lastUpdated": "2022-10-22T20:50:45.6221607+01:00[Europe/London]", // The time the data was last updated
"entries": [
{
"name": "Lemmmy", // The username of the player
"time": 53010 // Their total active (non-AFK) time, in seconds
},
{ /* ... */ }
]
}
# /v3/donation
Returns the current donation goal.
{
"donationUrl": "https://donate.sc3.io", // The URL to the donation page
"current": "5.00", // The current amount donated
"goal": "10.00", // The goal amount
"goalMet": false // Whether the goal has been met
}
# /v3/deaths
Returns the top 50 players with the most deaths in descending order.
[
{
"uuid": "cdb33b76-a445-47a1-b13d-94f34e006243",
"name": "Lemmmy",
"count": 46
},
{ "uuid": "07b382be-f2a8-4bf0-b9f5-c3a1b73c18c7",
"name": "Yemmel",
"count": 21
},
{ "uuid": "cf151463-687c-47cb-a248-2bbc9494afd7",
"name": "Lignum",
"count": 9
}
]