Docs
View as Markdown

speedrun.game_categories

stable Advanced

List the run categories of a speedrun.com game.

GET /v1/speedrun/game_categories

What you get#

A list of Speedrun results in Onekey's unified shape, in data (an array). An empty array is a normal, successful answer and is charged like any other; a source that reports "nothing found" as an error returns a free 404 not_found instead.

What it costs#

  • Advanced · 5 credits 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
gamestringyes(required)Game id or abbreviation, e.g. smb1max 40 chars; must match [a-z0-9_-]{2,40}; trimmed, lowercased

Request#

curl "https://api.onekey.dev/v1/speedrun/game_categories?game=smb1" \
  -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 Speedrun response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json
{
  "success": true,
  "data": [
    {
      "entity": {
        "id": "w20p0zkn",
        "name": "Any%",
        "url": "https://www.speedrun.com/smb1?h=Any&x=w20p0zkn",
        "type": "per-game"
      },
      "content": {
        "text": "*Please click on the \"Game Rules\" tab above to familiarize yourself with our rules for all categories.*\n\n## Goal\r\n\nBeat the game as fast as possible by any means necessary.\n\n## Timing\r\n\nTiming is done using the SDA standard:\n\nStart - The frame \"400\" appears in the top right corner after selecting 1 player.\n\nEnd - The frame all sprites are invisible after touching the axe in 8-4.\n\n## Category Rules\r\r\n\n- Using save states to the title screen is prohibited. You must use the reset function on your emulator or console and the reset must be shown in the video.\n- Only runs faster than 5:03 (5:08 for PAL) are represented with milliseconds on the leaderboard. Please do not include milliseconds if your time is not below this threshold.\n- It is recommended to hold onto full session, split files, input files, etc. in the event that a moderator requests additional evidence for verification.\n\nTimes below 4:57.000 are treated with additional scrutiny. The following is required for submissions below this threshold:\n\n- The run's full session must be included in the submission's description. Additional attempt sessions may be requested at the discretion of the moderation team.\n- For emulator submissions, the run must have an input display visible at all times. A hand-cam or input visualizer program is sufficient for emulators without a built-in input display."
      },
      "ext": {
        "players": 1
      }
    },
    {
      "entity": {
        "id": "wdmz042q",
        "name": "Warpless",
        "url": "https://www.speedrun.com/smb1?h=Warpless&x=wdmz042q",
        "type": "per-game"
      },
      "content": {
        "text": "*Please click on the \"Game Rules\" tab above to familiarize yourself with our rules for all categories.*\n\n## Goal\r\n\nFrom a new game, beat the game as fast as possible without using the warp zones.\n\n## Timing\r\n\nTiming is done using the SDA standard:\n\nStart - The frame \"400\" appears in the top right corner after selecting 1 player.\n\nEnd - The frame all sprites are invisible after touching the axe in 8-4.\n\n## Category Rules\r\n\n- Using save states to the title screen is prohibited. You must use the reset function on your emulator or console and the reset must be shown in the video.\n- Only runs faster than 19:13 are represented with milliseconds on the leaderboard. Please do not include milliseconds if your time is not below this threshold.\n- It is recommended to hold onto full session, split files, input files, etc. in the event that a moderator requests additional evidence for verification."
      },
      "ext": {
        "players": 1
      }
    }
  ],
  "metadata": {
    "platform": "speedrun",
    "endpoint": "game_categories",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 5,
    "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
identity.id-
nameentity.name-
weblinkentity.urlsafeUrl
typeentity.type-
rulescontent.text-
players.valueext.playerstoNumber

Caching and freshness#

  • Fresh for about 1 hour. Repeat calls in that window are served from cache and are free.
  • Between 1 hour and 1 day 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 2 days 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_foundUnknown endpoint path.
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).