PUBLISH Mass Cancel

PUB wss://test-api.synquote.com/ws

Cancels multiple orders at once.

REQUEST

HEADER PARAMS
msg_type string required
Message type: mass_cancel
id number required
The ID of the request. This is returned in the response header.
version integer required
Version number: 1
BODY PARAMS
account_id string required
Orders associated with this account will be cancelled.
instrument_id string
Only orders for this instrument will be mass cancelled. If absent, empty, or *, all account orders will be cancelled.
Example
[
  {
    "msg_type":"mass_cancel",
    "id": 1002,
    "version": 1
  },
  {
    "account_id": "0x9f58498b98348b9BFbE53F0E18AA818a4Be0aE49",
    "instrument_id": "ETH-PERPETUAL"
  }
]

RESPONSE

number_cancelled integer
The number of orders that were successfully cancelled.
Example
[
  {
    "msg_type":"mass_cancel_response",
    "id": 1002,
    "version": 1
  },
  {
    "number_cancelled": 10
  }
]