Skip to main content
These schemas are derived from backend Joi validation and intended for integration-time validation in your own systems.

​
Body schemas

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$defs": {
    "BuyV2Request": {
      "type": "object",
      "required": ["itemId", "price", "market"],
      "properties": {
        "itemId": { "type": "string", "pattern": "^[0-9]+$" },
        "price": { "type": "number" },
        "market": { "type": "string", "enum": ["c5game", "ecosteam"] },
        "tradeUrl": {
          "type": "string",
          "pattern": "^https://(www\\.)?steamcommunity\\.com/tradeoffer/new/\\?partner=[0-9]+&token=."
        }
      },
      "additionalProperties": false
    },
    "BuyV1Request": {
      "type": "object",
      "required": ["itemId", "price", "method", "market"],
      "properties": {
        "itemId": { "type": "string", "pattern": "^[0-9]+$" },
        "price": { "type": "number" },
        "method": { "type": "string", "enum": ["balance"] },
        "market": { "type": "string", "enum": ["c5", "ecosteam"] },
        "tradeURL": {
          "type": "string",
          "pattern": "^https://(www\\.)?steamcommunity\\.com/tradeoffer/new/\\?partner=[0-9]+&token=."
        }
      },
      "additionalProperties": false
    },
    "PartnerListingDetailV2Request": {
      "type": "object",
      "required": ["items"],
      "properties": {
        "items": {
          "type": "array",
          "minItems": 1,
          "maxItems": 10,
          "items": {
            "type": "object",
            "required": ["item", "listing", "market"],
            "properties": {
              "item": { "type": "string", "pattern": "^[0-9a-f]{16}$" },
              "listing": { "type": "string", "pattern": "^[0-9]+$" },
              "market": { "type": "string", "enum": ["c5game", "ecosteam"] }
            },
            "additionalProperties": false
          }
        }
      },
      "additionalProperties": false
    },
    "CreateSubAccountRequest": {
      "type": "object",
      "required": ["email"],
      "properties": {
        "email": { "type": "string", "format": "email" },
        "name": { "type": "string", "maxLength": 128 },
        "description": { "type": "string", "maxLength": 500 }
      },
      "additionalProperties": false
    },
    "PartnerTransferRequest": {
      "type": "object",
      "required": ["amountCents", "idempotencyKey"],
      "properties": {
        "toEmail": { "type": "string", "format": "email" },
        "toApiKeyId": { "type": "string", "pattern": "^[0-9a-fA-F]{24}$" },
        "amountCents": { "type": "integer", "minimum": 1 },
        "idempotencyKey": { "type": "string", "maxLength": 128 }
      },
      "oneOf": [
        { "required": ["toEmail"], "not": { "required": ["toApiKeyId"] } },
        { "required": ["toApiKeyId"], "not": { "required": ["toEmail"] } }
      ],
      "additionalProperties": false
    },
    "WithdrawRequest": {
      "type": "object",
      "required": ["token", "network", "address", "amount"],
      "properties": {
        "token": { "type": "string", "enum": ["USDC", "USDT"] },
        "network": { "type": "string" },
        "address": { "type": "string" },
        "amount": { "type": "number", "minimum": 10 }
      },
      "additionalProperties": false
    },
    "CryptoDepositRequest": {
      "type": "object",
      "required": ["token", "amount", "network"],
      "properties": {
        "token": { "type": "string", "enum": ["USDT", "BTC", "ETH", "USDC", "SOL", "DAI", "POL"] },
        "amount": { "type": "number", "exclusiveMinimum": 0 },
        "network": { "type": "string" }
      },
      "additionalProperties": false
    },
    "OnrampSessionRequest": {
      "type": "object",
      "required": ["fiatType"],
      "properties": {
        "coinId": { "type": "integer", "enum": [54, 116] },
        "coinCode": { "type": "string", "enum": ["usdt", "usdc"] },
        "chainId": { "type": "integer", "enum": [0, 1, 2, 16] },
        "fiatType": { "type": "integer", "enum": [12, 20, 21] },
        "fiatAmount": { "type": "number", "exclusiveMinimum": 0 },
        "coinAmount": { "type": "number", "exclusiveMinimum": 0 },
        "type": { "type": "integer", "enum": [1] },
        "network": { "type": "string" },
        "paymentMethod": { "type": "integer", "enum": [1, 2] },
        "redirectUrl": { "type": ["string", "null"] }
      },
      "anyOf": [{ "required": ["fiatAmount"] }, { "required": ["coinAmount"] }],
      "additionalProperties": false
    },
    "OnrampQuoteRequest": {
      "type": "object",
      "required": ["fiatAmount", "fiatType", "type", "coinCode", "network"],
      "properties": {
        "fiatAmount": { "type": "number", "exclusiveMinimum": 0 },
        "fiatType": { "type": "integer", "enum": [12, 20, 21] },
        "type": { "type": "integer", "enum": [1] },
        "coinCode": { "type": "string", "enum": ["usdt", "usdc"] },
        "network": { "type": "string" },
        "countryCode": { "type": "string", "minLength": 2, "maxLength": 2 }
      },
      "additionalProperties": false
    }
  }
}

​
Query schemas

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$defs": {
    "ListingsV2Query": {
      "type": "object",
      "required": ["item"],
      "properties": {
        "item": { "type": "string", "pattern": "^[0-9a-f]{16}$" },
        "page": { "type": "integer", "minimum": 1 },
        "delivery": { "type": "string", "enum": ["normal", "auto"] }
      }
    },
    "SearchV2Query": {
      "type": "object",
      "properties": {
        "q": { "type": "string" },
        "start": { "type": "integer", "minimum": 1 },
        "end": { "type": "integer", "minimum": 1 },
        "minPrice": { "type": "number", "minimum": 0 },
        "maxPrice": { "type": "number", "minimum": 0 },
        "sort": { "type": "string", "enum": ["abc", "priceAsc", "popularity", "priceDesc"] }
      }
    }
  }
}