WOO X · Schema

CreateOrder

CompanyCryptocurrencyExchangeTradingDerivatives

Properties

Name Type Description
symbol string Symbol name
clientOrderId integer Valid input ranges from 0 to 9223372036854775807
orderTag string Optional tag for this order, max string length: 64
side string BUY/SELL
positionSide string Position side; The default is BOTH in the one way mode; Can only be LONG or SHORT in the hedge mode. Only applicable to perpetual instruments.
type string LIMIT/MARKET/IOC/FOK/POST_ONLY/ASK/BID/AC/RPI where AC/RPI are only available to market makers.
price string Only applicable to LIMIT/IOC/FOK/POST_ONLY orders; MARKET/ASK/BID orders will ignore this field
quantity string Either quantity or amount is required; If both are passed, the request will be rejected
amount string Only applicable to MARKET/ASK/BID orders on spot instruments; Either quantity or amount is required; If both are passed, the request will be rejected
reduceOnly boolean Only applicable to perpetual instruments; Whether the order can only reduce in position size; valid options are true/false
visibleQuantity string The order quantity visible on orderbook
marginMode string CROSS / ISOLATED
bidAskLevel string [1..5](only effective if type = ASK / BID)
postOnlyAdjusted boolean Only applicable to POST_ONLY orders; Whether the order should be adjusted to the best bid/ask if it would cross the book and execute immediately as a taker
View JSON Schema on GitHub

JSON Schema

woox-create-order-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/woox/main/json-schema/woox-create-order-schema.json",
  "title": "CreateOrder",
  "x-generated": "2026-10-13",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/woox-openapi.json#/components/schemas/CreateOrder",
  "required": [
    "symbol",
    "side",
    "type"
  ],
  "type": "object",
  "properties": {
    "symbol": {
      "type": "string",
      "description": "Symbol name"
    },
    "clientOrderId": {
      "type": "integer",
      "description": "Valid input ranges from 0 to 9223372036854775807"
    },
    "orderTag": {
      "type": "string",
      "description": "Optional tag for this order, max string length: 64"
    },
    "side": {
      "type": "string",
      "description": "BUY/SELL"
    },
    "positionSide": {
      "type": "string",
      "description": "Position side; The default is BOTH in the one way mode;  Can only be LONG or SHORT in the hedge mode.  Only applicable to perpetual instruments."
    },
    "type": {
      "type": "string",
      "description": "LIMIT/MARKET/IOC/FOK/POST_ONLY/ASK/BID/AC/RPI where AC/RPI are only available to market makers."
    },
    "price": {
      "type": "string",
      "description": "Only applicable to LIMIT/IOC/FOK/POST_ONLY orders;  MARKET/ASK/BID orders will ignore this field"
    },
    "quantity": {
      "type": "string",
      "description": "Either quantity or amount is required;  If both are passed, the request will be rejected"
    },
    "amount": {
      "type": "string",
      "description": "Only applicable to MARKET/ASK/BID orders on spot instruments;  Either quantity or amount is required;  If both are passed, the request will be rejected"
    },
    "reduceOnly": {
      "type": "boolean",
      "description": "Only applicable to perpetual instruments; Whether the order can only reduce in position size; valid options are true/false"
    },
    "visibleQuantity": {
      "type": "string",
      "description": "The order quantity visible on orderbook"
    },
    "marginMode": {
      "type": "string",
      "description": "CROSS / ISOLATED"
    },
    "bidAskLevel": {
      "type": "string",
      "description": "[1..5](only effective if type = ASK / BID)"
    },
    "postOnlyAdjusted": {
      "type": "boolean",
      "description": "Only applicable to POST_ONLY orders; Whether the order should be adjusted to the best bid/ask if it would cross the book and execute immediately as a taker"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/woox-create-order"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.