ExchangeNewOrderSinglePayload

ExchangeNewOrderSinglePayload schema from Blockchain.com WebSocket APIs

CryptocurrencyBitcoinBlockchain DataExchangeMarket DataTradingPaymentsPublic APIs

Properties

Name	Type	Description
action	string
channel	string
clOrdID	string	FIX 11 — client reference for the order.
symbol	string	FIX 55
ordType	string	FIX 40
timeInForce	string	FIX 59 — required for limit, stop, stopLimit.
side	string	FIX 54
orderQty	number	FIX 38 — size in base currency.
price	number	FIX 44 — required for limit and stopLimit.
expireDate	integer	FIX 432 — YYYYMMDD; required for GTD orders.
stopPx	number	FIX 99 — required for stop and stopLimit.
minQty	number	FIX 110 — optional minimum quantity for IOC fills.
execInst	string	FIX 18 — Add Liquidity Only / post-only flag.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/blockchain/refs/heads/main/json-schema/com-exchange-new-order-single-payload-schema.json",
  "title": "ExchangeNewOrderSinglePayload",
  "description": "ExchangeNewOrderSinglePayload schema from Blockchain.com WebSocket APIs",
  "type": "object",
  "properties": {
    "action": {
      "type": "string",
      "const": "NewOrderSingle"
    },
    "channel": {
      "type": "string",
      "const": "trading"
    },
    "clOrdID": {
      "type": "string",
      "maxLength": 20,
      "description": "FIX 11 \u2014 client reference for the order."
    },
    "symbol": {
      "type": "string",
      "description": "FIX 55"
    },
    "ordType": {
      "type": "string",
      "enum": [
        "market",
        "limit",
        "stop",
        "stopLimit"
      ],
      "description": "FIX 40"
    },
    "timeInForce": {
      "type": "string",
      "enum": [
        "GTC",
        "GTD",
        "IOC",
        "FOK"
      ],
      "description": "FIX 59 \u2014 required for limit, stop, stopLimit."
    },
    "side": {
      "type": "string",
      "enum": [
        "buy",
        "sell"
      ],
      "description": "FIX 54"
    },
    "orderQty": {
      "type": "number",
      "description": "FIX 38 \u2014 size in base currency."
    },
    "price": {
      "type": "number",
      "description": "FIX 44 \u2014 required for limit and stopLimit."
    },
    "expireDate": {
      "type": "integer",
      "description": "FIX 432 \u2014 YYYYMMDD; required for GTD orders."
    },
    "stopPx": {
      "type": "number",
      "description": "FIX 99 \u2014 required for stop and stopLimit."
    },
    "minQty": {
      "type": "number",
      "description": "FIX 110 \u2014 optional minimum quantity for IOC fills."
    },
    "execInst": {
      "type": "string",
      "enum": [
        "ALO"
      ],
      "description": "FIX 18 \u2014 Add Liquidity Only / post-only flag."
    }
  },
  "required": [
    "action",
    "channel",
    "clOrdID",
    "symbol",
    "ordType",
    "side",
    "orderQty"
  ]
}