Skip to main content

private/cancel-order-list (LIST)

REQUEST 
wss://stream.crypto.com/exchange/v1/user
private/cancel-order-list (LIST)Private
Cancel a list of orders on the Exchange.

This call is asynchronous, so the response is simply a confirmation of the request.

The user.order subscription can be used to check when each of the orders is successfully cancelled.

Request​

Body

required
    id int64required

    Request id (echoed in response)

    method stringrequired

    Must be "private/cancel-order-list"

    nonce int64required

    Current timestamp in milliseconds, e.g. "1771761038000".

    params objectrequired
    contingency_type WsContingencyTypeList (string)required

    Possible values: [LIST]

    Must be LIST for order-list APIs

    order_list object[]required
    List of orders to be cancelled. Each item: instrument_name (optional), order_id, client_oid (optional).
  • Array [
    • instrument_name string

    Instrument name, e.g. ETH_CRO, BTC_USDT.

    order_id int64

    Order ID.

    client_oid string

    Optional Client order ID (maximum 36 characters).

  • ]
WebSocket response
Schema
    id int64

    Echoed request id

    method string

    Method invoked

    code int32

    0 = success; non-zero indicates error (reason code).

    result object[]
    Present when code === 0. Array of { code, index, message } per docs.
  • Array [
    • code int32

    0 if success.

    index int32

    The index of corresponding order request (start from 0).

    message string

    (Optional) For server or error messages.

  • ]
    • message string

    Response message. Contains additional reason when code !== 0.

    original string

    Present when code !== 0.