StartAPI
API
Für Apps, Bots und Overlays. Öffentliche Daten brauchen keinen Token. Vollständige Beschreibung: openapi.json (v0.1.0).
Live
get
Live updates (Server-Sent Events)
/v1/stream ?fragments, topics, format, tenantLive updates (Server-Sent Events)
get
Changed page fragments since given versions (polling fallback)
/v1/fragments ?ids, v, tenantChanged page fragments since given versions (polling fallback)
Öffentlich
get
Community info, event catalogue, resources, scopes
/v1/meta ?tenantCommunity info, event catalogue, resources, scopes
get
Current state of one resource (ETag/304 supported)
/v1/resources/{resource} ?tenantCurrent state of one resource (ETag/304 supported)
get
Server status
/v1/server/status ?tenantServer status
get
Ranked ladder (singles | doubles)
/v1/ranked/ladder/{fmt} ?tenantRanked ladder (singles | doubles)
get
Recent matches
/v1/ranked/matches ?tenantRecent matches
get
Active auction listings
/v1/market/listings ?tenantActive auction listings
get
Activity feed
/v1/activity ?tenantActivity feed
get
Public events after a cursor (polling, catch-up after reconnect)
/v1/events ?since, limit, types, tenantPublic events after a cursor (polling, catch-up after reconnect)
Mit Anmeldung oder Token
get
Who am I (token info)
/v1/me ?tenantWho am I (token info)
post
Queue an action for the game server
/v1/actions ?tenantQueue an action for the game server
get
Action status
/v1/actions/{aid} ?tenantAction status
post
Start an in-game code login (cookie flow for the website)
/v1/auth/login/start ?tenantStart an in-game code login (cookie flow for the website)
get
Poll the code login; sets the session cookie when confirmed
/v1/auth/login/status ?tenantPoll the code login; sets the session cookie when confirmed
get
Logged-in player (session cookie)
/v1/auth/me ?tenantLogged-in player (session cookie)
post
Log out (deletes the session)
/v1/auth/logout ?tenantLog out (deletes the session)
post
Personal read:player token for the logged-in player
/v1/auth/token ?tenantPersonal read:player token for the logged-in player
post
Queue an action for the logged-in player (session)
/v1/auth/action ?tenantQueue an action for the logged-in player (session)
get
Status of an own action
/v1/auth/action/{aid} ?tenantStatus of an own action
get
Own data for a personal token (scope read:player)
/v1/me/player ?tenantOwn data for a personal token (scope read:player)
Connector (Spielserver)
post
Push events (HMAC signed, batch up to 500)
/v1/ingest/events ?nPush events (HMAC signed, batch up to 500)
get
Lease queued actions (long poll up to 25 s)
/v1/connector/actions ?wait, limit, nLease queued actions (long poll up to 25 s)
post
Report an action's result
/v1/connector/actions/{aid}/ack ?nReport an action's result
Verwaltung der Community
get
Everything the community admin page shows
/v1/manage/overview ?tenantEverything the community admin page shows
post
Create a token (shown once)
/v1/manage/tokens ?tenantCreate a token (shown once)
delete
Revoke a token
/v1/manage/tokens/{tid} ?tenantRevoke a token
post
Approve a whitelist request (queues whitelist.approve for the game server)
/v1/manage/whitelist/{rid}/approve ?tenantApprove a whitelist request (queues whitelist.approve for the game server)
get
Export all community data as JSON (no secrets, no sessions)
/v1/manage/export ?tenantExport all community data as JSON (no secrets, no sessions)
post
New connector secret; the old one stays valid 24 h
/v1/manage/connectors/{cid}/rotate ?tenantNew connector secret; the old one stays valid 24 h
post
Create a webhook (secret shown once)
/v1/manage/webhooks ?tenantCreate a webhook (secret shown once)
post
Send a test event to a webhook now
/v1/manage/webhooks/{wid}/test ?tenantSend a test event to a webhook now
delete
Delete a webhook
/v1/manage/webhooks/{wid} ?tenantDelete a webhook
patch
Name, language, colours, packs, hidden players
/v1/manage/settings ?tenantName, language, colours, packs, hidden players
Neue Community
post
Create a community with an invite code (returns admin token, connector and collector config once)
/v1/onboardCreate a community with an invite code (returns admin token, connector and collector config once)