WS Amend Order

WS Amend Order

Amend orders via private WebSocket connection. Up to 20 orders per request.

Prerequisites

A valid listenKey must be obtained and the private WebSocket connection must be established before sending trade requests.

Request Format

{"action":"batch-amend-orders","param":{"id":"1006","args":[{...},{...}]}}

Field	Required	Type	Description
action	Yes	string	Fixed as "batch-amend-orders"
param	Yes	object	Batch amend parameters
param.id	Yes	string	Client request ID, used to match response
param.args	Yes	array	Amend arguments array, 1 to 20 objects

args[N] Object Fields

Field Name	Required	Type	Description
ordId	Yes	string	Order ID
px	Yes	number	New order price
sz	No	integer	New order quantity (in contracts)

Request Example

{
  "action": "batch-amend-orders",
  "param": {
    "id": "1006",
    "args": [
      {"ordId": "1000587867035933", "px": 6000.5, "sz": 5},
      {"ordId": "1000587867035934", "px": 6100.5}
    ]
  }
}

Response Format

{"id":"1006","action":"batch-amend-orders","code":"0","msg":"","data":[{"ordId":"1000587867035933","sCode":"0","sMsg":""},{"ordId":"","sCode":"50012","sMsg":"amend failed: OrderNotFound"}]}

Response Parameters

Field Name	Type	Description
id	string	Client request ID, matching the request
action	string	Fixed as "batch-amend-orders"
code	string	Result code, "0" means all items processed
msg	string	Result message
data	array	Per-order results, in the same order as args
data[].ordId	string	Order ID, empty on failure
data[].sCode	string	Per-item result code, "0" means success
data[].sMsg	string	Per-item result message

Processing Rules

Scenario	Code	Message
All orders amended	0
param is not valid JSON	50018	Invalid request json
args empty or > 20	50005	args length must be between 1 and 20
Single item: invalid arg	50003	Invalid arg (per-item sCode)
Single item: ordId/px is required	50003	ordId/px is required (per-item sCode)
Single item: invalid px/sz	50005	invalid px/sz (per-item sCode)
Single item: amend failed	50012	amend failed (per-item sCode)