Order Modified

As described in a previous section Order Commands - Modify Order, the Modify Order command can potentially affect the queue position of the order depending on which parameter of the original order has been modified. Orders retain their orderIds after modification.

Curl
{
  "table": "order", 
  "data": [
      {
          "accountId": "<Your account ID>",
          "clientOrderId": "1",
          "orderId": "1000021878849",
          "price": "30.0",
          "quantity": "0.001",
          "amount": "0.0",
          "side": "BUY",
          "status": "OPEN",
          "marketCode": "BTC-USD-SWAP-LIN",
          "timeInForce": "GTC",
          "timestamp": "1680044356374",
          "remainQuantity": "0.001",
          "limitPrice": "30.0",
          "notice": "OrderModified",
          "orderType": "LIMIT",
          "isTriggered": "false",
          "displayQuantity": "0.001"
      }
  ]
}

Channel Update Fields

Fields
Type
Description

table

STRING

order

data

LIST of dictionary

notice

STRING

OrderModified

accountId

STRING

Account identifier

clientOrderId

STRING

Client assigned ID to help manage and identify orders with max value 9223372036854775807

orderId

STRING

Unique order ID from the exchange

price

STRING

Limit price of modified order (only applicable for LIMIT order types)

quantity

STRING

Quantity of modified order

remainQuantity

STRING

Working quantity

amount

STRING

"0.0" if not provided in the request

side

STRING

BUY or SELL

status

STRING

Order status

marketCode

STRING

Market code e.g. BTC-USD-SWAP-LIN

timeInForce

STRING

Client submitted time in force, GTC by default

timestamp

STRING

Current millisecond timestamp

orderType

STRING

LIMIT or STOP_LIMIT

stopPrice

STRING

Stop price of modified order (only applicable for STOP order types)

limitPrice

STRING

Limit price of modified order

isTriggered

STRING

False or True

triggerType

STRING

Stops are triggered on MARK_PRICE

displayQuantity

STRING

Quantity displayed in the book, primarily used for iceberg orders, otherwise echos the quantity field

OrderModified Failure

Last updated