Reference
REST API
The HTTP endpoints behind the SDK. Games use the SDK; these are for tools, tests and server-to-server work.
Base URL: your ARCADE site (for example https://play.example.com). Requests and answers are JSON. Errors look like { "error": "CODE", "message": "..." }.
Game sessions
/api/v1/game-sessionsPlayer sign-in cookie, or none for a guest
Starts a play session for one game. Body { "gameSlug": "neon-drift" }. Answers 201 with sessionId, token, expiresAt (15 minutes), permissions and, for signed-in players on scoring games, playSessionId.
/api/v1/game-sessions/renewAuthorization: Bearer <token>
Pushes the expiry out another 15 minutes while the game is open.
/api/v1/game-sessions/currentAuthorization: Bearer <token>
Ends the session.
["player.read", "score.write", "leaderboard.read", "save.read", "save.write", "achievement.write", "event.write"]Cloud saves
/api/v1/games/:slug/dataBearer token or player cookie; signed-in players only
Lists the player's keys with version, sizeBytes and updatedAt.
/api/v1/games/:slug/data/:keyBearer token or player cookie
One value with its version; the ETag header carries the version.
/api/v1/games/:slug/data/:keyBearer token or player cookie
Body { "value": ... }. Optional If-Match: "3" saves only when the stored version is 3 ("0": only if new). 201 created, 200 updated, 409 version conflict, 413 over a limit.
/api/v1/games/:slug/data/:keyBearer token or player cookie
204, or 404 when there is no such key.
Events
/api/v1/games/:slug/eventsBearer token, or none with an anonymous sessionId
Body { "events": [{ "event": "level_completed", "metadata": { "level": 5 } }], "sessionId": "..." } (the session id only without a token). Up to 50 events; answers 202 with accepted and dropped.
Scores and leaderboards
/api/v1/games/:slug/scoresPlayer sign-in cookie
Body { "score": 4200, "submissionId": "...", "playSessionId": "..." }. 201 accepted, 202 held for review, 4xx rejected with the reason.
/api/v1/games/:slug/leaderboardPublic
?period=day|week|month|season|all, ?scope=everyone|following, ?limit=1..100. Signed-in players also get me, their own place.
/api/v1/leaderboards/globalPublic
Players ranked by XP across all games, with the same options.
Multiplayer
/api/v1/multiplayer/games/:slug/capabilityPublic
The game's multiplayer mode and player count.
/api/v1/multiplayer/roomsPlayer sign-in cookie
Creates a room; then /rooms/:roomId/join, /ready, /start, /matches/:matchId/actions and /finish. Live play uses the Socket.IO connection at /api/v1/multiplayer/socket.io.