Order Cancellation

Cancel Order

This request will attempt to cancel an existing order on the exchange.

Cancel Order Message

Name	Type	Comments
order_id	string	Optional - Exchange assigned order ID
client_order_id	string	Optional - Client assigned order ID
user_tag	string	Client defined tag used to identify the request

• One of order_id or client_order_id must be provided.

• A valid client_order_id takes precedence when matching with an order.

Example Request

{
  "cancel_order": {
    "order_id": "exchange_assigned_id",
    "client_order_id": "client_assigned_id",
    "user_tag": "unique_request_id"
  }
}

Cancel All Orders

This message will send a request to cancel all existing orders on the exchange.

Cancel All Orders Message

Name	Type	Comments
user_tag	string	Client defined tag used to identify the request

Example Requests

{
  "cancel_all_orders": {
    "user_tag": "unique_request_id"
  }
}

Order Cancelled

This is a message sent when a client's order has been cancelled.

info

For multi leg orders (2 or more legs), a legs array will be present and the top level while tradeable_entity_id and symbol will not be present.

Cancel Order Message

Name	Type	Comments
server_utc_timestamp	integer	Time at which the message was generated by the API
tradeable_entity_id	integer	Tradeable Entity Id (Not present for multi leg)
symbol	string	Instrument name e.g BTC-USD (Not present for multi leg)
order_id	integer	Order Id generated by the exchange
client_order_id	string	Unique Order Id generated by the client
timestamp	integer	Epoch Timestamp in ms
reason	string
legs	Leg array	cf below (Only present for multi leg orders)

Leg

Name	Type	Comments
tradeable_entity_id	number	Tradeable Entity Id
symbol	string	Instrument name e.g BTC-USD
ratio	integer

Examples

Single Leg

{
  "cancel_order": {
    "server_utc_timestamp": "34523454534656",
    "tradeable_entity_id": "7",
    "symbol": "BTC-USD",
    "order_id": "23123123",
    "client_order_id": "client order id 4",
    "timestamp": "43342423423434",
    "reason": "user cancelled"
  }
}

Multi Leg

{
  "cancel_order": {
    "server_utc_timestamp": "34523454534656",
    "order_id": "23123123",
    "client_order_id": "client order id 4",
    "timestamp": "43342423423434",
    "reason": "user cancelled",
    "legs": [
      { "tradeable_entity_id": "499", "ratio": "1" },
      { "tradeable_entity_id": "952", "ratio": "3" }
    ]
  }
}