0xDocs 0x.limo

Docs / REST API

Apps (stats, achievements, tickets, cloud, servers)

Generated reference for the 31 /v1/apps operations of the 0x REST API.

Generated from steamworks sg-backend/openapi.yaml at build 3a4a58e45c+dirty. Do not edit by hand.

Guide: Achievements and leaderboards, Cloud saves, Inventory, Payments and top-ups, Plays and stats. Errors are {"error": "..."} with the status (errors); limits are in rate limits.

MethodPathAuthSummary
GET/v1/apps/{appid}Bearer tokenApp schema
GET/v1/apps/{appid}/userstats/{steamid}Bearer tokenStats and achievements
PUT/v1/apps/{appid}/userstats/{steamid}Bearer tokenStore own stats
PUT/v1/apps/{appid}/presenceBearer tokenRich presence key/values
GET/v1/apps/{appid}/cloudBearer tokenCloud files:
GET/v1/apps/{appid}/cloud/{path}Bearer tokenRead a small file
PUT/v1/apps/{appid}/cloud/{path}Bearer tokenWrite a small file
DELETE/v1/apps/{appid}/cloud/{path}Bearer tokenDelete
POST/v1/apps/{appid}/cloud_uploadsBearer tokenBegin an upload:
POST/v1/apps/{appid}/cloud_commitBearer tokenCommit an upload:
POST/v1/apps/{appid}/cloud_downloadBearer token{name}
GET/v1/apps/{appid}/leaderboards/{name}Bearer tokenFind
POST/v1/apps/{appid}/lobbiesBearer tokenCreate {max_members, type}
POST/v1/apps/{appid}/lobbies/searchBearer tokenSearch with filters [{kind:
GET/v1/apps/{appid}/gameserversBearer tokenServer browser with master-server filters
POST/v1/apps/{appid}/ugcBearer tokenCreate an item {file_type}
POST/v1/apps/{appid}/ugc/queryBearer tokenQuery
GET/v1/apps/{appid}/ugc/subscribedBearer token[{id, subscribed_at}]
GET/v1/apps/{appid}/inventoryBearer tokenAll items
GET/v1/apps/{appid}/inventory/defsBearer tokenItem definitions and currency
GET/v1/apps/{appid}/inventory/pricesBearer tokenPrices and wallet balance
POST/v1/apps/{appid}/inventory/{action}Bearer tokenItem operations;
GET/v1/apps/{appid}/screenshotsBearer tokenThe caller's screenshots for the app
POST/v1/apps/{appid}/screenshotsBearer tokenUpload a PNG or JPEG
GET/v1/apps/{appid}/buildsBearer tokenPublishers:
POST/v1/apps/{appid}/buildsBearer tokenPublishers:
POST/v1/apps/{appid}/builds/{build}/{step}Bearer tokenPublishers:
POST/v1/apps/{appid}/rotate_keysBearer tokenPublishers:
GET/v1/apps/{appid}/depot_secretBearer tokenPublishers:
POST/v1/apps/{appid}/publisher_rootsBearer tokenPublishers:
GET/v1/apps/{appid}/depotBearer tokenOwners

#GET /v1/apps/{appid}

App schema (achievements, stats, DLC with ownership) and whether the caller owns it

Auth: Bearer token: Authorization: Bearer <access token> (authentication).

ParameterInTypeRequiredDescription
appidpathnumberyes
StatusResponse
200OK
bash
curl -s "https://api.0x.limo/v1/apps/$APPID" \
  -H "Authorization: Bearer $ZEROX_TOKEN"

#GET /v1/apps/{appid}/userstats/{steamid}

Stats and achievements

Auth: Bearer token: Authorization: Bearer <access token> (authentication).

ParameterInTypeRequiredDescription
appidpathnumberyes
steamidpathstringyes64-bit SteamID as a decimal string
StatusResponse
200OK UserStats
UserStats
ts
{
  stats?: { [key: string]: number };
  achievements?: { [key: string]: number | {
    achieved?: boolean;
    unlock_time?: number; // 0..18446744073709552000
  } }; // SDK format: name -> u32 unlock timestamp (0 is locked). The previously documented object format remains accepted for compatibility.
}
bash
curl -s "https://api.0x.limo/v1/apps/$APPID/userstats/$STEAMID" \
  -H "Authorization: Bearer $ZEROX_TOKEN"

#PUT /v1/apps/{appid}/userstats/{steamid}

Store own stats (game servers: players in their app); server-side min/max/increment-only rules apply

Auth: Bearer token: Authorization: Bearer <access token> (authentication).

ParameterInTypeRequiredDescription
appidpathnumberyes
steamidpathstringyes64-bit SteamID as a decimal string

Request body (application/json):

ts
{
  stats?: { [key: string]: number };
  achievements?: { [key: string]: number | {
    achieved?: boolean;
    unlock_time?: number; // 0..18446744073709552000
  } }; // SDK format: name -> u32 unlock timestamp (0 is locked). The previously documented object format remains accepted for compatibility.
}

Example:

json
{
  "stats": {
    "NumGames": 1
  },
  "achievements": {}
}
StatusResponse
200OK Ok
403Not yours
bash
curl -s -X PUT "https://api.0x.limo/v1/apps/$APPID/userstats/$STEAMID" \
  -H "Authorization: Bearer $ZEROX_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"stats":{"NumGames":1},"achievements":{}}'

#PUT /v1/apps/{appid}/presence

Rich presence key/values

Auth: Bearer token: Authorization: Bearer <access token> (authentication).

ParameterInTypeRequiredDescription
appidpathnumberyes
StatusResponse
200OK Ok
bash
curl -s -X PUT "https://api.0x.limo/v1/apps/$APPID/presence" \
  -H "Authorization: Bearer $ZEROX_TOKEN"

#GET /v1/apps/{appid}/cloud

Cloud files: [{name, size, timestamp}]

Auth: Bearer token: Authorization: Bearer <access token> (authentication).

ParameterInTypeRequiredDescription
appidpathnumberyes
StatusResponse
200OK CloudList
bash
curl -s "https://api.0x.limo/v1/apps/$APPID/cloud" \
  -H "Authorization: Bearer $ZEROX_TOKEN"

#GET /v1/apps/{appid}/cloud/{path}

Read a small file

Auth: Bearer token: Authorization: Bearer <access token> (authentication).

ParameterInTypeRequiredDescription
appidpathnumberyes
pathpathstringyesrelative path, / separated; no . or .. parts
StatusResponse
200File contents (application/octet-stream)
404Not found
bash
curl -s "https://api.0x.limo/v1/apps/$APPID/cloud/$PATH" \
  -H "Authorization: Bearer $ZEROX_TOKEN"

#PUT /v1/apps/{appid}/cloud/{path}

Write a small file

Auth: Bearer token: Authorization: Bearer <access token> (authentication).

ParameterInTypeRequiredDescription
appidpathnumberyes
pathpathstringyesrelative path, / separated; no . or .. parts

Request body (application/octet-stream):

ts
binary
StatusResponse
200OK
bash
curl -s -X PUT "https://api.0x.limo/v1/apps/$APPID/cloud/$PATH" \
  -H "Authorization: Bearer $ZEROX_TOKEN" \
  -H "Content-Type: application/octet-stream" --data-binary @file

#DELETE /v1/apps/{appid}/cloud/{path}

Delete

Auth: Bearer token: Authorization: Bearer <access token> (authentication).

ParameterInTypeRequiredDescription
appidpathnumberyes
pathpathstringyesrelative path, / separated; no . or .. parts
StatusResponse
200OK Ok
bash
curl -s -X DELETE "https://api.0x.limo/v1/apps/$APPID/cloud/$PATH" \
  -H "Authorization: Bearer $ZEROX_TOKEN"

#POST /v1/apps/{appid}/cloud_uploads

Begin an upload: {name, size} → {url} (pre-signed PUT)

Auth: Bearer token: Authorization: Bearer <access token> (authentication).

ParameterInTypeRequiredDescription
appidpathnumberyes
StatusResponse
200OK
bash
curl -s -X POST "https://api.0x.limo/v1/apps/$APPID/cloud_uploads" \
  -H "Authorization: Bearer $ZEROX_TOKEN"

#POST /v1/apps/{appid}/cloud_commit

Commit an upload: {name, sha256} (hash-checked)

Auth: Bearer token: Authorization: Bearer <access token> (authentication).

ParameterInTypeRequiredDescription
appidpathnumberyes
StatusResponse
200OK
404Nothing staged
409sha256 mismatch
bash
curl -s -X POST "https://api.0x.limo/v1/apps/$APPID/cloud_commit" \
  -H "Authorization: Bearer $ZEROX_TOKEN"

#POST /v1/apps/{appid}/cloud_download

{name} → {url} (pre-signed GET)

Auth: Bearer token: Authorization: Bearer <access token> (authentication).

ParameterInTypeRequiredDescription
appidpathnumberyes
StatusResponse
200OK
bash
curl -s -X POST "https://api.0x.limo/v1/apps/$APPID/cloud_download" \
  -H "Authorization: Bearer $ZEROX_TOKEN"

#GET /v1/apps/{appid}/leaderboards/{name}

Find (or create) a leaderboard: {id, name, sort, display, entry_count}

Auth: Bearer token: Authorization: Bearer <access token> (authentication).

ParameterInTypeRequiredDescription
appidpathnumberyes
namepathstringyes
createquery"1"no
sortquerynumberno
displayquerynumberno
StatusResponse
200OK
404No such leaderboard
bash
curl -s "https://api.0x.limo/v1/apps/$APPID/leaderboards/$NAME" \
  -H "Authorization: Bearer $ZEROX_TOKEN"

#POST /v1/apps/{appid}/lobbies

Create {max_members, type}

Auth: Bearer token: Authorization: Bearer <access token> (authentication).

ParameterInTypeRequiredDescription
appidpathnumberyes
StatusResponse
200OK Lobby
Lobby
ts
{
  id: string;
  appid: number;
  owner: string;
  members: string[];
  member_data?: object;
  data: { [key: string]: string };
  max_members: number;
  type: number; // ELobbyType
  joinable: boolean;
  game_server?: object | null;
  personas?: { [key: string]: string };
}
bash
curl -s -X POST "https://api.0x.limo/v1/apps/$APPID/lobbies" \
  -H "Authorization: Bearer $ZEROX_TOKEN"

#POST /v1/apps/{appid}/lobbies/search

Search with filters [{kind: string|numerical|near|slots|count, key, value, cmp}]

Auth: Bearer token: Authorization: Bearer <access token> (authentication).

ParameterInTypeRequiredDescription
appidpathnumberyes
StatusResponse
200OK
bash
curl -s -X POST "https://api.0x.limo/v1/apps/$APPID/lobbies/search" \
  -H "Authorization: Bearer $ZEROX_TOKEN"

#GET /v1/apps/{appid}/gameservers

Server browser with master-server filters (map, gamedir, gametagsand, gametagsnor, notfull, hasplayers, noplayers, dedicated, secure, password, name_match)

Auth: Bearer token: Authorization: Bearer <access token> (authentication).

ParameterInTypeRequiredDescription
appidpathnumberyes
StatusResponse
200OK
bash
curl -s "https://api.0x.limo/v1/apps/$APPID/gameservers" \
  -H "Authorization: Bearer $ZEROX_TOKEN"

#POST /v1/apps/{appid}/ugc

Create an item {file_type} → {id}

Auth: Bearer token: Authorization: Bearer <access token> (authentication).

ParameterInTypeRequiredDescription
appidpathnumberyes
StatusResponse
200OK
bash
curl -s -X POST "https://api.0x.limo/v1/apps/$APPID/ugc" \
  -H "Authorization: Bearer $ZEROX_TOKEN"

#POST /v1/apps/{appid}/ugc/query

Query (kind all|user|details, filters, sort, paging) → {total, items, next_cursor}

Auth: Bearer token: Authorization: Bearer <access token> (authentication).

ParameterInTypeRequiredDescription
appidpathnumberyes
StatusResponse
200OK
bash
curl -s -X POST "https://api.0x.limo/v1/apps/$APPID/ugc/query" \
  -H "Authorization: Bearer $ZEROX_TOKEN"

#GET /v1/apps/{appid}/ugc/subscribed

[{id, subscribed_at}]

Auth: Bearer token: Authorization: Bearer <access token> (authentication).

ParameterInTypeRequiredDescription
appidpathnumberyes
StatusResponse
200OK
bash
curl -s "https://api.0x.limo/v1/apps/$APPID/ugc/subscribed" \
  -H "Authorization: Bearer $ZEROX_TOKEN"

#GET /v1/apps/{appid}/inventory

All items (signed result)

Auth: Bearer token: Authorization: Bearer <access token> (authentication).

ParameterInTypeRequiredDescription
appidpathnumberyes
StatusResponse
200OK InventoryResult
InventoryResult
ts
{
  result: number; // EResult (1 = OK)
  error?: string;
  items: {
    id: number; // 1..18446744073709552000
    def: number; // 1..9223372036854776000
    qty: number; // 0..18446744073709552000
    flags: number; // 0..
    acquired: number; // 0..
    origin: string;
    props: object;
  }[];
  ts?: number;
  signed?: string; // hex: SGINV1 blob, Ed25519-signed by the service key
}
bash
curl -s "https://api.0x.limo/v1/apps/$APPID/inventory" \
  -H "Authorization: Bearer $ZEROX_TOKEN"

#GET /v1/apps/{appid}/inventory/defs

Item definitions and currency

Auth: Bearer token: Authorization: Bearer <access token> (authentication).

ParameterInTypeRequiredDescription
appidpathnumberyes
StatusResponse
200OK
bash
curl -s "https://api.0x.limo/v1/apps/$APPID/inventory/defs" \
  -H "Authorization: Bearer $ZEROX_TOKEN"

#GET /v1/apps/{appid}/inventory/prices

Prices and wallet balance

Auth: Bearer token: Authorization: Bearer <access token> (authentication).

ParameterInTypeRequiredDescription
appidpathnumberyes
StatusResponse
200OK
bash
curl -s "https://api.0x.limo/v1/apps/$APPID/inventory/prices" \
  -H "Authorization: Bearer $ZEROX_TOKEN"

#POST /v1/apps/{appid}/inventory/{action}

Item operations; results are Ed25519-signed; a purchase debits the wallet in the same transaction

The action selects its request schema below. Missing optional consume.qty defaults to one; malformed supplied quantities never do. Inventory business rejection remains HTTP 200 with result != 1; conflicting idempotency reuse is HTTP 409. Extra object fields are tolerated for forward compatibility.

Auth: Bearer token: Authorization: Bearer <access token> (authentication). Accepts Idempotency-Key.

ParameterInTypeRequiredDescription
appidpathnumberyes
actionpath"by\_id" | "promo" | "consume" | "exchange" | "transfer" | "drop" | "purchase" | "properties"yes
Idempotency-Keyheaderstringno

Request body (application/json, required):

ts
ByIdRequest | PromoRequest | ConsumeRequest | ExchangeRequest | TransferRequest | DropRequest | PurchaseRequest | PropertiesRequest
StatusResponse
200OK InventoryResult
InventoryResult
ts
{
  result: number; // EResult (1 = OK)
  error?: string;
  items: {
    id: number; // 1..18446744073709552000
    def: number; // 1..9223372036854776000
    qty: number; // 0..18446744073709552000
    flags: number; // 0..
    acquired: number; // 0..
    origin: string;
    props: object;
  }[];
  ts?: number;
  signed?: string; // hex: SGINV1 blob, Ed25519-signed by the service key
}
bash
curl -s -X POST "https://api.0x.limo/v1/apps/$APPID/inventory/$ACTION" \
  -H "Authorization: Bearer $ZEROX_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

#GET /v1/apps/{appid}/screenshots

The caller's screenshots for the app

Auth: Bearer token: Authorization: Bearer <access token> (authentication).

ParameterInTypeRequiredDescription
appidpathnumberyes
StatusResponse
200OK
bash
curl -s "https://api.0x.limo/v1/apps/$APPID/screenshots" \
  -H "Authorization: Bearer $ZEROX_TOKEN"

#POST /v1/apps/{appid}/screenshots

Upload a PNG or JPEG (query width, height, name) → {id}

Auth: Bearer token: Authorization: Bearer <access token> (authentication).

ParameterInTypeRequiredDescription
appidpathnumberyes
StatusResponse
200OK
400Not an image
bash
curl -s -X POST "https://api.0x.limo/v1/apps/$APPID/screenshots" \
  -H "Authorization: Bearer $ZEROX_TOKEN"

#GET /v1/apps/{appid}/builds

Publishers: builds and branches

Auth: Bearer token: Authorization: Bearer <access token> (authentication).

ParameterInTypeRequiredDescription
appidpathnumberyes
StatusResponse
200OK
403Not a publisher
bash
curl -s "https://api.0x.limo/v1/apps/$APPID/builds" \
  -H "Authorization: Bearer $ZEROX_TOKEN"

#POST /v1/apps/{appid}/builds

Publishers: new build {files: [{path, id, size, mode?, key?, type?, wt?, parts?: [{id, size, key?, wt?}]}], description?} → {build_id, missing} (a file in parts: id = SHA-256 of the part ids joined by newlines, size = their sum; wt = the object's WebTorrent infohash, 40 hex, stored as given; notes/15)

Auth: Bearer token: Authorization: Bearer <access token> (authentication).

ParameterInTypeRequiredDescription
appidpathnumberyes
StatusResponse
200OK
400Bad manifest (unsafe or duplicate path
403Not a publisher
409A content id belongs to another app
bash
curl -s -X POST "https://api.0x.limo/v1/apps/$APPID/builds" \
  -H "Authorization: Bearer $ZEROX_TOKEN"

#POST /v1/apps/{appid}/builds/{build}/{step}

Publishers: uploads {ids} → pre-signed PUT URLs; commit {id} (hash-checked, then on the origin); publish {branch, statement?} (statement: the publisher's signed build statement, relayed to clients unverified)

Auth: Bearer token: Authorization: Bearer <access token> (authentication).

ParameterInTypeRequiredDescription
appidpathnumberyes
buildpathnumberyes
steppath"uploads" | "commit" | "publish"yes
StatusResponse
200OK
404No such build or nothing uploaded
409Bytes don't match the id, or files missing at publish
bash
curl -s -X POST "https://api.0x.limo/v1/apps/$APPID/builds/$BUILD/$STEP" \
  -H "Authorization: Bearer $ZEROX_TOKEN"

#POST /v1/apps/{appid}/rotate_keys

Publishers: bump the key generation (future encrypted builds derive new keys and ids even for unchanged files; notes/15)

Auth: Bearer token: Authorization: Bearer <access token> (authentication).

StatusResponse
200OK
403Not a publisher
bash
curl -s -X POST "https://api.0x.limo/v1/apps/$APPID/rotate_keys" \
  -H "Authorization: Bearer $ZEROX_TOKEN"

#GET /v1/apps/{appid}/depot_secret

Publishers: the app's key-derivation secret for encrypted builds

Auth: Bearer token: Authorization: Bearer <access token> (authentication).

ParameterInTypeRequiredDescription
appidpathnumberyes
StatusResponse
200OK
403Not a publisher
bash
curl -s "https://api.0x.limo/v1/apps/$APPID/depot_secret" \
  -H "Authorization: Bearer $ZEROX_TOKEN"

#POST /v1/apps/{appid}/publisher_roots

Publishers: append the next signed publisher root {doc} (trusted keys; version = previous + 1). Stored and relayed; clients verify it.

Auth: Bearer token: Authorization: Bearer <access token> (authentication).

ParameterInTypeRequiredDescription
appidpathnumberyes
StatusResponse
200OK
400Not a root document for this app
403Not a publisher
409Not the next version
bash
curl -s -X POST "https://api.0x.limo/v1/apps/$APPID/publisher_roots" \
  -H "Authorization: Bearer $ZEROX_TOKEN"

#GET /v1/apps/{appid}/depot

Owners (public branch) and publishers: the build's manifest {build_id, files: [{path, id, size, mode, encrypted, type?, wt?, parts?}], publisher?: {roots, statement}}

Auth: Bearer token: Authorization: Bearer <access token> (authentication).

ParameterInTypeRequiredDescription
appidpathnumberyes
branchquerystringno
StatusResponse
200OK
403Not entitled
404No build on that branch
bash
curl -s "https://api.0x.limo/v1/apps/$APPID/depot" \
  -H "Authorization: Bearer $ZEROX_TOKEN"