Private

Batch Modify Order Channel

Description

This channel uses a two-tier status code structure:

Outer code / msg: whether the batch order modification request as a whole was accepted
Inner args[i].code / args[i].msg: the modification result of each individual order

An outer code=0 does not mean every sub-order succeeded.

The ACK response only indicates that the request has been successfully accepted. Please use the WebSocket order push channel to confirm the actual status of each order.

Isolated margin mode is not supported for batch order modification.


Code
{
    "args": [
        {
            "autoCancel": "yes",
            "clientOid": "1354237913333333333",
            "orderId": "1354237910333333333",
            "price": "5",
            "qty": "5",
            "requestId": 12345678
        },
        {
            "autoCancel": "yes",
            "clientOid": "1354240301222222222",
            "orderId": "1354240301222222222",
            "price": "5",
            "qty": "2",
            "requestId": 87654321
        }
    ],
    "id": "63210d1e-b400-47c7-afc6-323018afe71a",
    "op": "trade",
    "topic": "batch-modify"
}

Request Parameters

Parameter	Type	Required	Description
op	String	Yes	Operation: `trade`
id	String	Yes	Request identifier
topic	String	Yes	Topic `batch-modify`
category	String	No	Business line, lowercase only `spot` Spot trading `margin` Margin trading `usdt-futures` USDT Futures `coin-futures` Coin-M futures `usdc-futures` USDC Futures
args	List<Object>	Yes	Channel list
> orderId	String	No	Order ID Either orderId or clientOid is required. If both orderId and clientOid are passed simultaneously, orderId takes higher priority, and the clientOid parameter will be ignored.
> clientOid	String	No	Client order ID Either orderId or clientOid is required. If both orderId and clientOid are passed simultaneously, orderId takes higher priority, and the clientOid parameter will be ignored.
> qty	String	No	Order quantity - Spot For market buy orders, the unit is quote coin For limit and market sell orders, the unit is base coin - Futures The unit is base coin
> price	String	No	Order price This field is required when orderType is `limit`
> autoCancel	String	No	Will the original order be canceled if the order modification fails `yes`: Cancel `no`: Not cancel（default） When set to `yes`: if the matching engine fails to modify the order, the order is cancelled immediately; after cancellation, the counter will reject any further modification requests for that order (including in-flight and new requests).
> symbol	String	No	Symbol name, case-insensitive
> requestId	Number	No	Custom request ID used to identify the order modification request Only supports numbers within 18 digits Returned when autoCancel=yes and the modify order request is rejected
> pxAmendType	String	No	Order price amendment type `no` When the order price exceeds the price limit range, the system is not allowed to adjust the order price; the order will be rejected (default) `yes` When the order price exceeds the price limit range, the system is allowed to adjust the price to the best value within the limit range and place the order Only applicable to limit orders (`orderType`=`limit`)


Code
{
  "event": "trade",
  "id": "63210d1e-b400-47c7-afc6-323018afe71a",
  "topic": "batch-modify",
  "args": [
    {
      "code": "25571",
      "msg": "The modification price and qty is the same as the original value. Please adjust and try again.",
      "orderId": "1354237913333333333",
      "clientOid": "1354237910333333333",
      "requestId": 12345678,
      "receiveTime": "1750034396998123",
      "pushTime": "1750034397076456"
    },
    {
      "code": "0",
      "msg": "Success",
      "orderId": "1354240301222222222",
      "clientOid": "1354240301222222222",
      "requestId": 87654321,
      "receiveTime": "1750034396999456",
      "pushTime": "1750034397077789"
    }
  ],
  "code": "0",
  "msg": "Success",
  "connId": "xxxxxxxxxx",
  "rateLimit": [
    {
      "limit": "10",
      "remaining": "9"
    }
  ],
  "ts": "1758602036638"
}

Response Parameters

Parameters	Type	Description
event	String	Event `trade`/`error`
id	String	Request identifier
topic	String	Topic `batch-modify`
args	List<Object>	Channel list
> orderId	String	Order ID
> clientOid	String	Client order ID
> requestId	Number	Custom request ID Only returned when passed in the modify-order request
> receiveTime	String	Gateway receive time Unix microsecond timestamp
> pushTime	String	Gateway push time Unix microsecond timestamp
> code	String	Code
> msg	String	Message
code	String	Code
msg	String	Message
connId	String	Connection ID
rateLimit	Array	Rate limit balance array
> limit	String	Rate limit quota for this dimension
> remaining	String	Remaining available quota
ts	String	Timestamp

Batch Cancel Order Channel Account Channel

{
    "args": [
        {
            "autoCancel": "yes",
            "clientOid": "1354237913333333333",
            "orderId": "1354237910333333333",
            "price": "5",
            "qty": "5",
            "requestId": 12345678
        },
        {
            "autoCancel": "yes",
            "clientOid": "1354240301222222222",
            "orderId": "1354240301222222222",
            "price": "5",
            "qty": "2",
            "requestId": 87654321
        }
    ],
    "id": "63210d1e-b400-47c7-afc6-323018afe71a",
    "op": "trade",
    "topic": "batch-modify"
}

Parameter

Type

Required

Description

String

Yes

Operation:
trade

String

Yes

Request identifier

topic

String

Yes

Topic
batch-modify

category

String

Business line, lowercase only
spot Spot trading
margin Margin trading
usdt-futures USDT Futures
coin-futures Coin-M futures
usdc-futures USDC Futures

args

List<Object>

Yes

Channel list

> orderId

String

Order ID
Either orderId or clientOid is required.
If both orderId and clientOid are passed simultaneously, orderId takes higher priority, and the clientOid parameter will be ignored.

> clientOid

String

Client order ID
Either orderId or clientOid is required.
If both orderId and clientOid are passed simultaneously, orderId takes higher priority, and the clientOid parameter will be ignored.

> qty

String

Order quantity
- Spot
For market buy orders, the unit is quote coin
For limit and market sell orders, the unit is base coin
- Futures
The unit is base coin

> price

String

Order price
This field is required when orderType is limit

> autoCancel

String

Will the original order be canceled if the order modification fails
yes: Cancel
no: Not cancel（default）
When set to yes: if the matching engine fails to modify the order, the order is cancelled immediately; after cancellation, the counter will reject any further modification requests for that order (including in-flight and new requests).

> symbol

String

Symbol name, case-insensitive

> requestId

Number

Custom request ID used to identify the order modification request
Only supports numbers within 18 digits
Returned when autoCancel=yes and the modify order request is rejected

> pxAmendType

String

Order price amendment type
no When the order price exceeds the price limit range, the system is not allowed to adjust the order price; the order will be rejected (default)
yes When the order price exceeds the price limit range, the system is allowed to adjust the price to the best value within the limit range and place the order
Only applicable to limit orders (orderType=limit)

{
  "event": "trade",
  "id": "63210d1e-b400-47c7-afc6-323018afe71a",
  "topic": "batch-modify",
  "args": [
    {
      "code": "25571",
      "msg": "The modification price and qty is the same as the original value. Please adjust and try again.",
      "orderId": "1354237913333333333",
      "clientOid": "1354237910333333333",
      "requestId": 12345678,
      "receiveTime": "1750034396998123",
      "pushTime": "1750034397076456"
    },
    {
      "code": "0",
      "msg": "Success",
      "orderId": "1354240301222222222",
      "clientOid": "1354240301222222222",
      "requestId": 87654321,
      "receiveTime": "1750034396999456",
      "pushTime": "1750034397077789"
    }
  ],
  "code": "0",
  "msg": "Success",
  "connId": "xxxxxxxxxx",
  "rateLimit": [
    {
      "limit": "10",
      "remaining": "9"
    }
  ],
  "ts": "1758602036638"
}

Parameters

Type

Description

event

String

Event
trade/error

String

Request identifier

topic

String

Topic
batch-modify

args

List<Object>

Channel list

> orderId

String

Order ID

> clientOid

String

Client order ID

> requestId

Number

Custom request ID
Only returned when passed in the modify-order request

> receiveTime

String

Gateway receive time
Unix microsecond timestamp

> pushTime

String

Gateway push time
Unix microsecond timestamp

> code

String

Code

> msg

String

Message

code

String

Code

msg

String

Message

connId

String

Connection ID

rateLimit

Array

Rate limit balance array

> limit

String

Rate limit quota for this dimension

> remaining

String

Remaining available quota

String

Timestamp