Skip to main content

Request

{
    "message": "modifyOrder",
    "content": {
        "clientRequestId": "e1669c3d-a31b-43e3-8239-03da43c9ca73",
        "market": "ETH-USD",
        "orderId": "01KHPJAA0QBAJEXQJ941F7SWW7",
        "price": "1999.00",
        "quantity": "1.00"
    }
}
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": "ETH-USD",
    "data": {
        "statusCode": 202,
        "body": "modifying order",
        "order": {
            "market": "ETH-USD",
            "orderId": "01KHPJAA0QBAJEXQJ941F7SWW7",
            "orderType": "sell",
            "tradeType": "limit",
            "price": "1999.00",
            "quantity": "1.00",
            "filledQuantity": "0",
            "leverage": "10",
            "createdAt": 1771357677591,
            "updatedAt": 1771357677701,
            "orderStatus": "modifying",
            "clientRequestId": "e1669c3d-a31b-43e3-8239-03da43c9ca73",
            "postOnly": false
        },
        "clientRequestId": "e1669c3d-a31b-43e3-8239-03da43c9ca73",
        "apiQuotaUsed": 5
    }
}
FieldTypeRequiredDescription
resultTypestringYesmodifyOrder
marketstringNoMarket name, present when connected with market=ALL
data.statusCodenumberYes202
data.bodystringYesStatus message
data.order.marketstringYesMarket name
data.order.orderIdstringYesUnique identifier for the original order
data.order.orderTypestringYesOrder side: buy or sell
data.order.tradeTypestringYesOrder type: limit or market
data.order.pricestringYesNew price used
data.order.quantitystringYesNew remaining quantity
data.order.filledQuantitystringYesNew filled quantity
data.order.leveragestringYesLeverage used at order modification
data.order.createdAtnumberYesMilliseconds since epoch
data.order.updatedAtnumberYesMilliseconds since epoch
data.order.orderStatusstringYesmodifying
data.order.clientRequestIdstringNoClient-generated UUID for correlation
data.order.postOnlybooleanYesMaker-only creation flag, same as the original order
data.clientRequestIdstringNoClient-generated UUID for correlation
data.apiQuotaUsednumberYesAPI quota consumed

Response — Original Order Modified Notice

{
    "resultType": "modifyOrder",
    "market": "ETH-USD",
    "data": {
        "statusCode": 200,
        "body": "original order modified",
        "order": {
            "market": "ETH-USD",
            "orderId": "01KHPJAA0QBAJEXQJ941F7SWW7",
            "orderType": "sell",
            "tradeType": "limit",
            "price": "2000.00",
            "quantity": "2.00",
            "filledQuantity": "0",
            "leverage": "10",
            "createdAt": 1771357677591,
            "updatedAt": 1771357677701,
            "orderStatus": "modified",
            "clientRequestId": "e1669c3d-a31b-43e3-8239-03da43c9ca73",
            "postOnly": false
        },
        "clientRequestId": "e1669c3d-a31b-43e3-8239-03da43c9ca73"
    }
}
FieldTypeRequiredDescription
resultTypestringYesmodifyOrder
marketstringNoMarket name, present when connected with market=ALL
data.statusCodenumberYes200
data.bodystringYesStatus message
data.order.marketstringYesMarket name
data.order.orderIdstringYesUnique identifier for the original order
data.order.orderTypestringYesOrder side: buy or sell
data.order.tradeTypestringYesOrder type: limit or market
data.order.pricestringYesOriginal price used
data.order.quantitystringYesOriginal remaining quantity
data.order.filledQuantitystringYesOriginal filled quantity
data.order.leveragestringYesLeverage used at order modification
data.order.createdAtnumberYesMilliseconds since epoch
data.order.updatedAtnumberYesMilliseconds since epoch
data.order.orderStatusstringYesmodified
data.order.clientRequestIdstringNoClient-generated UUID for correlation
data.order.postOnlybooleanYesMaker-only creation flag, same as the original order
data.clientRequestIdstringNoClient-generated UUID for correlation

Response — New Order Pending Notice

{
    "resultType": "modifyOrder",
    "market": "ETH-USD",
    "data": {
        "statusCode": 200,
        "body": "new order created, pending acceptance",
        "order": {
            "market": "ETH-USD",
            "orderId": "01KHPJD4JARPZJVN44BKVMMM66",
            "orderType": "sell",
            "tradeType": "limit",
            "price": "1999",
            "quantity": "1",
            "filledQuantity": "0",
            "leverage": "10",
            "createdAt": 1771357770314,
            "updatedAt": 1771357770314,
            "orderStatus": "pending",
            "clientRequestId": "e1669c3d-a31b-43e3-8239-03da43c9ca73",
            "postOnly": false
        },
        "clientRequestId": "e1669c3d-a31b-43e3-8239-03da43c9ca73"
    }
}
FieldTypeRequiredDescription
resultTypestringYesmodifyOrder
marketstringNoMarket name, present when connected with market=ALL
data.statusCodenumberYes200
data.bodystringYesStatus message
data.order.marketstringYesMarket name
data.order.orderIdstringYesNew unique identifier for the modified order
data.order.orderTypestringYesOrder side: buy or sell
data.order.tradeTypestringYesOrder type: limit or market
data.order.pricestringYesNew price used
data.order.quantitystringYesNew remaining quantity
data.order.filledQuantitystringYesNew filled quantity
data.order.leveragestringYesLeverage used at order modification
data.order.createdAtnumberYesMilliseconds since epoch
data.order.updatedAtnumberYesMilliseconds since epoch
data.order.orderStatusstringYespending
data.order.clientRequestIdstringNoClient-generated UUID for correlation
data.order.postOnlybooleanYesMaker-only creation flag, same as the original order
data.clientRequestIdstringNoClient-generated UUID for correlation

Response — Creation Confirmation

{
    "resultType": "createOrder",
    "market": "ETH-USD",
    "data": {
        "statusCode": 200,
        "body": "order accepted",
        "order": {
            "market": "ETH-USD",
            "orderId": "01KHPJD4JARPZJVN44BKVMMM66",
            "orderType": "sell",
            "tradeType": "limit",
            "price": "1999",
            "quantity": "1",
            "filledQuantity": "0",
            "leverage": "10",
            "createdAt": 1771357770314,
            "updatedAt": 1771357770314,
            "orderStatus": "active",
            "clientRequestId": "e1669c3d-a31b-43e3-8239-03da43c9ca73",
            "postOnly": false
        },
        "clientRequestId": "e1669c3d-a31b-43e3-8239-03da43c9ca73"
    }
}
FieldTypeRequiredDescription
resultTypestringYescreateOrder
marketstringNoMarket name, present when connected with market=ALL
data.statusCodenumberYes200
data.bodystringYesStatus message
data.order.marketstringYesMarket name
data.order.orderIdstringYesNew unique identifier for the modified order
data.order.orderTypestringYesOrder side: buy or sell
data.order.tradeTypestringYesOrder type: limit or market
data.order.pricestringYesNew price used
data.order.quantitystringYesNew remaining quantity
data.order.filledQuantitystringYesNew filled quantity
data.order.leveragestringYesLeverage used at order modification
data.order.createdAtnumberYesMilliseconds since epoch
data.order.updatedAtnumberYesMilliseconds since epoch
data.order.orderStatusstringYesactive
data.order.clientRequestIdstringNoClient-generated UUID for correlation
data.order.postOnlybooleanYesMaker-only creation flag, same as the original order
data.clientRequestIdstringNoClient-generated UUID for correlation

Response — Error

{
  "resultType": "createOrder",
  "market": "ETH-USD",
  "data": {
    "statusCode": 400,
    "body": "maximum open orders count of 80 reached",
    "order": {
      "market": "ETH-USD",
      "orderId": "01KHPJD4JARPZJVN44BKVMMM66",
      "orderType": "sell",
      "tradeType": "limit",
      "price": "1999",
      "quantity": "1",
      "filledQuantity": "0",
      "leverage": "10",
      "createdAt": 1771357770314,
      "updatedAt": 1771357770314,
      "orderStatus": "rejected",
      "clientRequestId": "e1669c3d-a31b-43e3-8239-03da43c9ca73",
      "postOnly": false
    },
    "error": {
      "slug": "CREATE_ORDER_ERROR",
      "code": "1000"
    },
    "apiQuotaUsed": 1,
    "clientRequestId": "e1669c3d-a31b-43e3-8239-03da43c9ca73"
  }
}
{
  "resultType": "createOrder",
  "market": "ETH-USD",
  "data": {
    "statusCode": 408,
    "body": "order activation timeout, pending order rejected",
    "error": {
      "slug": "CREATE_ORDER_ERROR",
      "code": "1000"
    },
    "apiQuotaUsed": 1,
    "clientRequestId": "e1669c3d-a31b-43e3-8239-03da43c9ca73"
  }
}
{
  "resultType": "modifyOrder",
  "market": "ETH-USD",
  "data": {
    "statusCode": 429,
    "body": "api call rate limit exceeded",
    "error": {
      "slug": "TOO_MANY_REQUESTS",
      "code": "0003"
    },
    "apiQuotaUsed": 10001,
    "retryAfterSec": 300,
    "clientRequestId": "e1669c3d-a31b-43e3-8239-03da43c9ca73"
  }
}
{
  "resultType": "modifyOrder",
  "market": "ETH-USD",
  "data": {
    "statusCode": 500,
    "body": "Internal Server Error",
    "error": {
      "slug": "MODIFY_ORDER_ERROR",
      "code": "3000"
    },
    "apiQuotaUsed": 1,
    "clientRequestId": "e1669c3d-a31b-43e3-8239-03da43c9ca73"
  }
}
FieldTypeRequiredDescription
resultTypestringYesmodifyOrder or createOrder
marketstringNoMarket name, present when connected with market=ALL
data.statusCodenumberYesError status (400, 408, 429, 500)
data.bodystringYesError description
data.order.marketstringNoMarket name
data.order.orderIdstringNoUnique identifier for the order (original or new)
data.order.orderTypestringNoOrder side: buy or sell
data.order.tradeTypestringNoOrder type: limit or market
data.order.pricestringNoPrice used (original or new)
data.order.quantitystringNoRemaining quantity (original or new)
data.order.filledQuantitystringNoFilled quantity (original or new)
data.order.leveragestringNoLeverage used at order modification
data.order.createdAtnumberNoMilliseconds since epoch
data.order.updatedAtnumberNoMilliseconds since epoch
data.order.orderStatusstringNorejected
data.order.clientRequestIdstringNoClient-generated UUID for correlation
data.order.postOnlybooleanNoMaker-only creation flag, same as the original order
data.error.slugstringYesError slug
data.error.codestringYesError code
data.apiQuotaUsednumberNoPresent for quota responses
data.retryAfterSecnumberNoPresent when throttled
data.clientRequestIdstringNoClient-generated UUID for correlation