The developer API lets a studio game's Roblox servers talk to the platform with the game's own API key. A game's servers use it to read market data the platform has collected (any tracked game's current players, its history, the genres and the whole market) and to send player feedback, which the game's crew triages on the game's Feedback tab in the panel.
These docs are public at docs.blockoutgames.com, with the API described as an OpenAPI 3.1 document and an interactive reference you can try with your game's key. The Roblox Template is the SDK: a Template game gets every route by switching its platform service on, and there is no separate package.
Every route, parameter and answer, with Try it.
What Try it sends, where, and what happens to your key.
Create, rotate and revoke the key on the game's Developer tab.
The Template's platform service
The ready-made Luau service: switch it on, set the secret, call it.
Its layers, the shared cache's lease, failures and how to extend it.
A worked example: live players of a list of games, every minute.
Every refusal, the rate limits, caching and how often to ask.
Where the key lives, what never to do, and what to do if it leaks.
Which read answers which question.
What changed in v1, and when.
The base URL of the developer API
Every route lives under one address:
https://studio.blockoutgames.com/developer/v1The panel at studio.blockoutgames.com is the API's only public door. It forwards every GET and POST under /developer/v1/ to the API with the Authorization header, the body, If-None-Match and the client address, and never a cookie. A path the API does not serve answers 404.
How a request is authenticated
Every request sends the game's key as a bearer token, and nothing else identifies the game:
GET https://studio.blockoutgames.com/developer/v1/keyAuthorization: Bearer bk_live_<the game's key>A key is bk_live_ followed by 43 letters, digits, - or _. Each studio game has at most one key in use. The API hashes the key it is sent (SHA-256) and looks the hash up on every request, so a rotated or revoked key stops at once: nothing caches the lookup. A missing, malformed, wrong or revoked key, or the key of a game that left the studio's catalog, all get the same 401. See Getting a game's API key.
Every route of the developer API
| Route | What it answers |
|---|---|
| GET /developer/v1/key | The game the key belongs to, and its limit per minute |
| GET /developer/v1/games | A page of tracked games, or the games named in ids (up to 100) |
| GET /developer/v1/games/:id | One tracked game in full |
| GET /developer/v1/games/:id/history | A game's players over 6 hours to all time |
| GET /developer/v1/genres | Each first-level genre with its games and players |
| GET /developer/v1/market | Players in the most played games over time, by genre, new games a week |
GET /developer/v1/game/analytics | The key's own game's owned analytics by day, as the panel shows them |
GET /developer/v1/game/feedback | The key's own game's player feedback, newest first |
GET /developer/v1/items/limiteds | Roblox's limited items with their RAP, value, demand and trend |
GET /developer/v1/game/breakdowns | The key's own game's daily analytics by platform, country, age and source |
GET /developer/v1/game/feedback/themes | The key's own game's feedback by theme, week by week |
GET /developer/v1/key/usage | The key's own requests over 24 hours and 7 days |
POST /developer/v1/game/releases | Records a release of the key's own game in its release log |
POST /developer/v1/game/bans | Bans a player in every studio game whose group key allows it (optional) |
POST /developer/v1/game/transfers | Sends a player's progress to another studio game, for it to claim once |
POST /developer/v1/game/transfers/claim | Claims a player's progress another studio game sent to the key's game |
| POST /developer/v1/feedback | Stores a player's feedback for the game's crew |
The reads answer from data the platform already stored. The two /game/... reads take no id: they answer for the game the key belongs to, and no other. No route asks Roblox anything or starts tracking a game, so a game's servers never spend the collector's Roblox budget. Every answer is JSON; times are ISO 8601 in UTC, and null means unknown, never zero.
The limits on a game's key
- Per keyrequests a minute
120, for every server of the game together, reads and feedback alike (
GAME_API_RATE_LIMIT_PER_KEY).- Every key togetherrequests a minute
1,200 for every game's key together: the developer API's ceiling (
GAME_API_RATE_LIMIT_TOTAL).- Per addressrequests a minute
1,200 reads and 240 writes from one client address, counted before the key is read.
- Bodybytes
A declared body larger than 16 KiB is refused with
413before key lookup. Fastify parses the body before the route's guard runs.
A refusal over a limit is 429 with a Retry-After header. Because the 120 is shared by every server, read through one shared cache: the Template's platform service does this for you. See Errors, limits and polling.
Quick start for a Blockout Template game
Create the key
Open the game in the panel's Studio section, then its Developer tab, and choose Create key. Copy it: it is shown once. See Getting a game's API key.
Store it as a Roblox secret
Add a secret named
BlockoutApiKeywith the key as its value andstudio.blockoutgames.comas its domain, in the Creator Dashboard for live servers and in Studio's Local Secrets for testing.Allow HTTP requests
In Studio, File, Experience Settings, Security, turn on Allow HTTP Requests, then publish.
Switch the platform on
Set
platform = truein the game'ssrc/core/shared/Config/Overrides/Features.luau(return { platform = true }).Call it
From a server service's
start()or atask.spawnthread, callPlatformService.key()to check the key, thenPlatformService.games({ ids = { … } })and the rest. See The Template's platform service.
Calling the developer API from a game not built on the Template
A game not built on the Template calls the routes itself with HttpService:RequestAsync, from a server script only, sending the key as the header built by HttpService:GetSecret("BlockoutApiKey"):AddPrefix("Bearer ") so it is never a string. Follow Errors, limits and polling so that every server together stays under 120 requests a minute: cache each answer in MemoryStore for a minute, batch games with ids, wait Retry-After on 429 and stop on 401. There is no separate Luau package for this: the Template is the SDK. For feedback, Sending feedback over HTTP has a complete sender.
Seeing how a key is used
The game's Developer tab shows the key in use's requests in the last 24 hours and the last 7 days, how many were refused or failed, how many were rate limited, and a count for each route. The counts are kept per UTC hour for eight days. A rotated key starts from zero. A climbing rate-limited count means the game asks too often.
Related pages
The game framework: setup, services, saving, gameplay systems and the platform bridge.
The key, its fingerprint and how it is used, in the panel.
How often the market data behind these routes is read.
Every tab of a studio game in the panel.
CCU, tier, breakout and the other words the answers use.
Updated