0xDocs 0x.limo

Docs / REST API

REST reference

Every public operation of the 0x REST API (94 operations in 18 groups), generated from the backend's OpenAPI document.

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

This reference is generated from sg-backend/openapi.yaml (OpenAPI 3.1.0, API version 1.0), the contract the backend's own tests check every route against. Base URL: https://api.0x.limo.

Not in the generated reference

The hosting routes (/v1/hosting/*) are not in the OpenAPI document yet; they are documented by hand in Hosting and versions.

#Shared schemas

#Error

ts
{
  error: string;
}

#Ok

ts
{
  ok: boolean;
}

#ItemId

ts
number

#DefinitionId

ts
number

#Quantity

ts
number

#GrantQuantity

ts
number

#GrantPair

ts
[number, number]

#IngredientPair

ts
[number, number]

#PurchaseRequest

ts
{
  items: ([number, number])[]; // at most 128 items
}

#ExchangeRequest

ts
{
  generate: ([number, number])[]; // at most 128 items
  destroy: ([number, number])[]; // at most 128 items
}

#TransferRequest

ts
{
  src: number; // 1..18446744073709552000
  qty: number; // 1..18446744073709552000
  dest?: number; // 1..18446744073709552000
}

#ConsumeRequest

ts
{
  id: number; // 1..18446744073709552000
  qty?: number; // 1..18446744073709552000
}

#ByIdRequest

ts
{
  ids: number[]; // at most 128 items
}

#PromoRequest

ts
{
  defs: number[]; // at most 128 items
}

#DropRequest

ts
{
  def: number; // 1..9223372036854776000
}

#PropertyName

ts
string

#PropertiesRequest

ts
{
  set?: ([number, string, any])[]; // at most 128 items
  remove?: ([number, string])[]; // at most 128 items
}

#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.
}

#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 };
}

#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
}

#CloudList

ts
{
  name: string;
  size: number; // 0..
  timestamp: number; // 0..
}[]

#TokenResponse

ts
{
  access_token: string;
  token_type: "Bearer";
  expires_in: number;
  refresh_token: string;
}