CreateOrderRequest

Payload for submitting a new order.

CryptocurrencyBitcoinBlockchain DataExchangeMarket DataTradingPaymentsPublic APIs

Properties

Name	Type	Description
clOrdId	string	Client-supplied order identifier.
ordType	string
timeInForce	string
symbol	string
side	string
orderQty	number
price	number
stopPx	number
minQty	number
expireDate	integer

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-create-order-request-schema.json",
  "title": "CreateOrderRequest",
  "description": "Payload for submitting a new order.",
  "type": "object",
  "properties": {
    "clOrdId": {
      "type": "string",
      "description": "Client-supplied order identifier.",
      "example": "21745988181"
    },
    "ordType": {
      "type": "string",
      "enum": [
        "limit",
        "market",
        "stop",
        "stopLimit"
      ],
      "example": "limit"
    },
    "timeInForce": {
      "type": "string",
      "enum": [
        "GTC",
        "IOC",
        "FOK",
        "GTD"
      ],
      "example": "GTC"
    },
    "symbol": {
      "type": "string",
      "example": "BTC-USD"
    },
    "side": {
      "type": "string",
      "enum": [
        "buy",
        "sell"
      ],
      "example": "buy"
    },
    "orderQty": {
      "type": "number",
      "example": 0.5
    },
    "price": {
      "type": "number",
      "example": 72525.0
    },
    "stopPx": {
      "type": "number"
    },
    "minQty": {
      "type": "number",
      "example": 0.5
    },
    "expireDate": {
      "type": "integer"
    }
  },
  "required": [
    "clOrdId",
    "ordType",
    "symbol",
    "side",
    "orderQty"
  ]
}