Reference
Public API
Read the catalogue, leaderboards and player profiles from your own site or app. No key, no sign-in.
These endpoints are open to everyone: no API key, no account and no sign-in. Any website can call them straight from the browser (they answer with Access-Control-Allow-Origin: *), and any server or script can call them too. They only read; nothing here changes data.
| Detail | How it works |
|---|---|
| Base URL | Your ARCADE site, for example https://play.example.com |
| Format | JSON. Errors look like { "error": "CODE", "message": "..." } |
| Limit | 600 requests a minute per IP address; past that the answer is 429 for the rest of the minute |
| Cookies | Not used. Calls from other websites never carry a player’s session |
const res = await fetch('https://play.example.com/api/v1/games?pageSize=10');
const { items, total } = await res.json();
items.forEach((game) => console.log(game.title, `https://play.example.com/games/${game.slug}`));curl "https://play.example.com/api/v1/games/neon-drift/leaderboard?period=week&limit=10"Games
/api/v1/gamesPublic
The live games, newest first. Query: search (title and description), category (a category slug), tag (a tag slug), page (from 1) and pageSize (1 to 200, default 12). Answers { items, page, pageSize, total }; each game has slug, title, description, category, tags, thumbnailUrl, trailerUrl (the hover preview, when there is one), playCount, averageRating and mobileCompatible.
Link players to a game at /games/:slug on the site.
/api/v1/games/featuredPublic
The games staff picked for the home page. Query limit.
/api/v1/games/:slugPublic
One live game, with everything above plus playerCount and favoriteCount. 404 when there is no such live game.
/api/v1/games/:slug/achievementsPublic
The game's achievements, with their name, description and XP reward.
/api/v1/games/:slug/commentsPublic
Players' comments on the game, newest first.
/api/v1/games/:slug/compatibilityPublic
Whether the game can be played and how it runs (playable, adapter).
/api/v1/multiplayer/games/:slug/capabilityPublic
The game's online play: mode (NONE, RACE, TURN_BASED, P2P), maxPlayers and whether it is enabled.
/api/v1/categoriesPublic
Every category with its slug, name, number of games and total plays.
/api/v1/tagsPublic
Every tag (name, slug), for the tag filter above.
Leaderboards
/api/v1/games/:slug/leaderboardPublic
One game's best scores. Query period (day, week, month, season or all, the default) and limit (1 to 100). Each entry has rank, username, displayName and score. enabled is false for games without a leaderboard.
/api/v1/leaderboards/globalPublic
Players ranked by XP earned across all games, with the same period and limit. Each entry has rank, username, xp and level.
/api/v1/leaderboards/seasonsPublic
The leaderboard seasons, and the current one.
Players
/api/v1/users/:usernamePublic
A player's public profile: display name, avatar, bio and a summary of their best scores. A player who made their profile private shows only their name (isPrivate: true).
/api/v1/users/:username/badgesPublic
The achievements the player has unlocked.
/api/v1/ranksPublic
The player ranks and the XP each one starts at.
Events
/api/v1/xp-eventsPublic
Double-XP events: live, upcoming and recent.
/api/v1/xp-events/activePublic
The event running now, if any, and its XP multiplier.