0xDocs 0x.limo

Docs / REST API

REST API overview

The 0x platform API at https://api.0x.limo/v1 — base URL, auth, content types, idempotency, versioning and a map of every area.

The 0x platform API is one JSON-over-HTTPS service. The launcher, the native Steam-compatible client (sg-steamclient), the WASM runtime, the 0x CLI and the @0xlimo/* packages all use it. Your game and your game servers can call it directly too.

Base URLhttps://api.0x.limo (every path starts with /v1/)
Push channelwss://api.0x.limo/v1/stream (Push stream)
FormatJSON request and response bodies, UTF-8
AuthAuthorization: Bearer <token> (Authentication)
Errors{"error": "..."} with the HTTP status (Errors)
Limitstoken buckets per caller and per address (Rate limits)
bashtested
curl -s https://api.0x.limo/v1/hosting/config

#Versioning

  • The version is the first path segment: /v1/. Inside v1 we only make changes that keep existing clients working: new endpoints, new optional request fields and new response fields. Ignore fields you don't know.
  • A change that would break clients gets a new prefix. /v1 keeps answering alongside it.
  • Some features are coded but switched off on 0x.limo, for example in-game purchases and subscriptions. Their routes answer 404 until they are switched on. Each page says which features are off.

#Requests

  • Bodies. Send Content-Type: application/json. The token endpoint also accepts application/x-www-form-urlencoded (RFC 6749). Uploads of raw bytes, such as hosting blobs, cloud files and trailers, send the bytes as the body.
  • Body size. api.0x.limo accepts request bodies up to 80 MB. Individual routes have their own lower limits, which their pages list (64 MiB per hosted file, for example).
  • IDs. Account and SteamID-style IDs are 64-bit and always travel as decimal strings ("76561197960287930"). Large numeric IDs from JavaScript lose precision otherwise. App IDs (appid) are numbers.
  • Money is in minor units (cents) as integers. Many responses add a ...Usd decimal string for display.
  • Times are Unix seconds unless a field says ms.
  • CORS. Browsers may call the API from the 0x world hosts and from every hosted site origin (https://<site>-play.0x.limo). Only bearer tokens authenticate. Cookies are never used, so requests are made without credentials.

#Idempotency

Operations that spend money accept an idempotency key. If you send the same key again, you get the first answer back and you are not charged a second time.

  • The Idempotency-Key header: 1 to 256 printable ASCII characters. Inventory operations (/v1/apps/{appid}/inventory/*) and store orders use it.
  • An idempotency_key field in the JSON body, where the reference says so. Orders, in-game purchase intents and consumes take it.

Generate a fresh random key, such as a UUID, for each user action. Reuse it only when you retry that same action.

#Pagination

Most lists are bounded and come back whole, for example at most 1000 wishlist entries or the 500 latest plays. The reference gives the bound for each one. The few paged lists use one of these:

  • next_cursor in the response, sent back as ?cursor= (reviews);
  • page / count fields in the request body (UGC queries, at most 50 a page);
  • start / end ranks (leaderboard entries).

#Health

GET /healthz (liveness) and GET /readyz (Postgres and Redis reachable, node not draining) need no token.

#Areas

AreaGuideWhat it covers
Sign-in and tokensAuthenticationOAuth 2.0 token endpoint, device and browser sign-in, publish tokens, game-server sessions, tickets
Store catalogCataloglistings, live player counts, popularity, reviews, store art
HostingHosting and versionssites, immutable versions, uploads, quota, publish tokens
Plays and statsPlays and statsplay sessions, library, user stats, global stats
InventoryInventoryISteamInventory items, exchanges, trades, signed results
Lobbies and matchmakingLobbies and matchmakinglobbies, search filters, game-server browser, party beacons
Achievements and leaderboardsAchievements and leaderboardsunlocks, percentages, scores, ranked entries
Friends and presenceFriends and presencefriends, rich presence, clans, chat
Cloud savesCloud savesper-player files per app, pre-signed transfers
TransfersTransfersswarm tracker, web seeds, transfer reports
Site security policyCSP reports and policydeclared origins, enforced policy, violation reports
PaymentsPayments and top-upsbalance, top-ups, paid games, in-game purchases (off), subscriptions (off), revenue
PushPush streamthe WebSocket event channel

The generated reference lists every documented operation with its parameters and responses, built from the backend's openapi.yaml.