Docs
View as Markdown

roblox.game

stable Standard

Fetch a Roblox experience by universe id.

GET /v1/roblox/game

What you get#

One Roblox record in Onekey's unified shape, in data. If the record does not exist you get a 404 not_found and are not charged.

What it costs#

  • Standard · 1 credit for a fresh fetch, charged only when it succeeds.
  • Free when served from cache (0.2 credit for a cached response over 100 KB).
  • Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

NameTypeRequiredDefaultWhat it isConstraints
idstringyes(required)Universe id, e.g. 13058max 12 chars; must match [0-9]{1,12}; trimmed

Request#

curl "https://api.onekey.dev/v1/roblox/game?id=13058" \
  -H "x-api-key: YOUR_API_KEY"

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real Roblox response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json
{
  "success": true,
  "data": {
    "entity": {
      "id": "13058",
      "name": "Crossroads",
      "description": "The classic Roblox level is back! Crossroads is Roblox's very first multiplayer game. It is a classic brick battle game with a destructible environment. All great warriors find themselves here.\n\n\"I joined the Roblox team just as they were rolling out the first multiplayer Roblox level - a very early version of Crossroads. This version featured a castle made by Erik and a white house and playground constructed by Builderman. There were two weapons: the slingshot and the rocket launcher. I remember the first time we noticed a user, “dergenx”, actually playing our game, everyone on the team got on and played with him for an hour. It was very exciting. Since the original Crossroads was published, it has been added onto many times as we push the state of the art forward.\" ~ Shedletsky, December 11th, 2006 \"Now We are 10,000\" - Celebrating the 10,000th Roblox user.",
      "stats": {
        "favorites": 316803
      },
      "category": "Fighting",
      "updatedAt": "2026-09-24T22:40:42Z"
    },
    "author": {
      "username": "Roblox",
      "id": "1"
    },
    "ext": {
      "playing": 431,
      "visits": 39203596,
      "maxPlayers": 15,
      "rootPlaceId": "1818"
    },
    "content": {
      "createdAt": "2007-05-01T01:07:04Z"
    }
  },
  "metadata": {
    "platform": "roblox",
    "endpoint": "game",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 1,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source pathOnekey fieldTransform
data.0.identity.idtoString
data.0.nameentity.name-
data.0.descriptionentity.description-
data.0.creator.nameauthor.username-
data.0.creator.idauthor.idtoString
data.0.playingext.playingtoNumber
data.0.visitsext.visitstoNumber
data.0.favoritedCountentity.stats.favoritestoNumber
data.0.maxPlayersext.maxPlayerstoNumber
data.0.genreentity.category-
data.0.createdcontent.createdAttoIsoDate
data.0.updatedentity.updatedAttoIsoDate
data.0.rootPlaceIdext.rootPlaceIdtoString

Caching and freshness#

  • Fresh for about 30 minutes. Repeat calls in that window are served from cache and are free.
  • Between 30 minutes and 6 hours the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
  • If the source is down when a refresh is needed, the last copy can be served for up to 1 day more (marked stale).
  • A "not found" is remembered for 5 minutes and is free.
  • The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

StatusCodeWhat to do
401unauthorizedCheck the x-api-key header.
402insufficient_creditsAdd credits; your balance must cover the price.
404not_foundThat record does not exist. Free; do not retry.
422invalid_paramsFix the parameters using the table above. Free.
429rate_limitedWait Retry-After seconds, then retry.
502upstream_errorThe source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).