Skip to main content

​
Request

{
  "message": "modifyOrder",
  "content": {
    "clientRequestId": "ee86bd11-6478-4aa2-917a-17c94b6c2db7",
    "market": "BTC-3JUL26-55000-C",
    "orderId": "01KWK47RT6A4DD1TCQE662QJ3W",
    "price": "6300",
    "quantity": "1"
  }
}
FieldTypeRequiredDescription
messagestringYesmodifyOrder
content.clientRequestIdstringNoClient-generated UUID for correlation
content.marketstringNoMarket name, only required when connecting with market=ALL
content.orderIdstringYesUnique identifier for the original order
content.pricestringYesNew order price
content.quantitystringYesNew order quantity

​
Response — Acknowledgment

{
  "resultType": "modifyOrder",
  "market": "BTC-3JUL26-55000-C",
  "data": {
    "statusCode": 202,
    "body": "order received",
    "order": {
      "market": "BTC-3JUL26-55000-C",
      "orderId": "01KWK47RT6A4DD1TCQE662QJ3W",
      "orderType": "buy",
      "tradeType": "limit",
      "price": "6300",
      "quantity": "1",
      "filledQuantity": "0",
      "leverage": "0",
      "orderStatus": "pending",
      "postOnly": false,
      "createdAt": 1783053411143,
      "updatedAt": 1783053548624,
      "clientRequestId": "ee86bd11-6478-4aa2-917a-17c94b6c2db7"
    },
    "clientRequestId": "ee86bd11-6478-4aa2-917a-17c94b6c2db7"
  }
}
FieldTypeRequiredDescription
resultTypestringYesmodifyOrder
marketstringYesContract name
data.statusCodenumberYes202
data.bodystringYesorder received
data.order.marketstringYesContract name
data.order.orderIdstringYesUnique order identifier
data.order.orderTypestringYesOrder side: buy or sell
data.order.tradeTypestringYesOrder type: limit or market
data.order.pricestringYesNew order price
data.order.quantitystringYesNew order quantity
data.order.filledQuantitystringYesQuantity filled so far
data.order.leveragestringYesLeverage — always 0 for options
data.order.orderStatusstringYespending
data.order.postOnlybooleanYesMaker-only flag
data.order.createdAtnumberYesCreation time (ms since epoch)
data.order.updatedAtnumberYesLast update time (ms since epoch)
data.order.clientRequestIdstringNoClient-generated UUID for correlation
data.clientRequestIdstringNoClient-generated UUID for correlation

​
Response — Confirmation

{
  "resultType": "modifyOrder",
  "market": "BTC-3JUL26-55000-C",
  "data": {
    "statusCode": 200,
    "body": "order placed",
    "order": {
      "market": "BTC-3JUL26-55000-C",
      "orderId": "01KWK47RT6A4DD1TCQE662QJ3W",
      "orderType": "buy",
      "tradeType": "limit",
      "price": "6300",
      "quantity": "1",
      "filledQuantity": "0",
      "leverage": "0",
      "orderStatus": "open",
      "postOnly": false,
      "createdAt": 1783053411143,
      "updatedAt": 1783053548626,
      "clientRequestId": "ee86bd11-6478-4aa2-917a-17c94b6c2db7"
    },
    "clientRequestId": "ee86bd11-6478-4aa2-917a-17c94b6c2db7"
  }
}
FieldTypeRequiredDescription
resultTypestringYesmodifyOrder
marketstringYesContract name
data.statusCodenumberYes200
data.bodystringYesorder placed
data.order.marketstringYesContract name
data.order.orderIdstringYesUnique order identifier
data.order.orderTypestringYesOrder side: buy or sell
data.order.tradeTypestringYesOrder type: limit or market
data.order.pricestringYesNew order price
data.order.quantitystringYesNew order quantity
data.order.filledQuantitystringYesQuantity filled so far
data.order.leveragestringYesLeverage — always 0 for options
data.order.orderStatusstringYesopen
data.order.postOnlybooleanYesMaker-only flag
data.order.createdAtnumberYesCreation time (ms since epoch)
data.order.updatedAtnumberYesLast update time (ms since epoch)
data.order.clientRequestIdstringNoClient-generated UUID for correlation
data.clientRequestIdstringNoClient-generated UUID for correlation

​
Response — Error

{
  "resultType": "modifyOrder",
  "market": "BTC-3JUL26-55000-C",
  "data": {
    "statusCode": 404,
    "body": "order not found",
    "error": {
      "code": "3003",
      "slug": "MODIFY_ORDER_NOT_FOUND_ERROR"
    },
    "clientRequestId": "ee86bd11-6478-4aa2-917a-17c94b6c2db7"
  }
}
FieldTypeRequiredDescription
resultTypestringYesmodifyOrder
marketstringYesContract name
data.statusCodenumberYesError status, e.g. 404
data.bodystringYesError description
data.error.slugstringYesMachine-readable error slug
data.error.codestringYesError code
data.clientRequestIdstringNoClient-generated UUID for correlation