Order

An order submitted to the matching engine.

CryptocurrencyBitcoinBlockchain DataExchangeMarket DataTradingPaymentsPublic APIs

Properties

Name	Type	Description
orderId	integer
gwOrderId	integer
clOrdId	string
symbol	string
ordType	string	Order type — `limit`, `market`, `stop`, `stopLimit`.
timeInForce	string	Time in force — `GTC`, `IOC`, `FOK`, `GTD`.
side	string	`buy` or `sell`.
orderQty	number
minQty	number
cumQty	number
price	number
stopPx	number
ordStatus	string	Status — `pending`, `open`, `filled`, `partial`, `cancelled`, `rejected`, `expired`.
expireDate	integer
execID	string
avgPx	number

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/exchange-order-schema.json",
  "title": "Order",
  "description": "An order submitted to the matching engine.",
  "type": "object",
  "properties": {
    "orderId": {
      "type": "integer",
      "format": "int64"
    },
    "gwOrderId": {
      "type": "integer",
      "format": "int64"
    },
    "clOrdId": {
      "type": "string",
      "example": "21745988181"
    },
    "symbol": {
      "type": "string",
      "example": "BTC-USD"
    },
    "ordType": {
      "type": "string",
      "description": "Order type \u2014 `limit`, `market`, `stop`, `stopLimit`."
    },
    "timeInForce": {
      "type": "string",
      "description": "Time in force \u2014 `GTC`, `IOC`, `FOK`, `GTD`."
    },
    "side": {
      "type": "string",
      "description": "`buy` or `sell`.",
      "example": "buy"
    },
    "orderQty": {
      "type": "number",
      "example": 0.5
    },
    "minQty": {
      "type": "number",
      "example": 0.5
    },
    "cumQty": {
      "type": "number",
      "example": 0.5
    },
    "price": {
      "type": "number",
      "example": 72525.0
    },
    "stopPx": {
      "type": "number"
    },
    "ordStatus": {
      "type": "string",
      "description": "Status \u2014 `pending`, `open`, `filled`, `partial`, `cancelled`, `rejected`, `expired`.",
      "example": "open"
    },
    "expireDate": {
      "type": "integer"
    },
    "execID": {
      "type": "string",
      "example": "21745988181"
    },
    "avgPx": {
      "type": "number"
    }
  }
}