Skip to content

API overview

The API lets you read detections, players and servers programmatically.

Base URL

https://web.thorium.ac

Authentication

Create a key under Networks → your network → API Keys, then send it as a bearer token:

Terminal window
curl -H "Authorization: Bearer $THORIUM_API_KEY" \
"https://web.thorium.ac/api/players/paginated?orgId=$ORG_ID&page=1&pageSize=50"

A key is scoped to the network that issued it. Creating and revoking keys requires the relevant permission — see members and roles.

Paging

List endpoints take page and pageSize (max 100) and return a pagination object with totalPages, hasNextPage and hasPreviousPage.

Common endpoints

MethodPathReturns
GET/api/players/paginatedPlayers, newest activity first
GET/api/players/paginated/detectionsDetections for the network
GET/api/players/{id}One player with recent detections
GET/api/servers?organizationId=Servers and connection state
GET/api/organizations/{id}/entitlementPlan, trial state, server allowance

Errors

StatusMeaning
401Missing or invalid key
403The key’s role lacks the permission
402The plan does not permit the action — for example adding a server past the allowance
429Rate limited. Retry-After says when to try again