Cancel All Orders – Cryptocurrency Guide - Crypto Facilities

This endpoint allows cancelling orders which are associated with a future's contract or a margin account. If no arguments are specified all open orders will be cancelled.

Authentication is required.

Endpoint	Request Type	Permissible API Keys
/api/v3/cancelallorders	POST	Read-write, Master

Argument	Type	Required	Description
symbol	string	No	A future product to cancel all open orders

Sample Call

https://www.cryptofacilities.com/derivatives/api/v3/cancelallorders

https://www.cryptofacilities.com/derivatives/api/v3/cancelallorders?symbol=pi_xbtusd

Sample Return if Successful

{
   "result":"success",
   "cancelStatus":{
      "receivedTime":"2019-08-01T15:57:37.518Z",
      "cancelOnly":"all",
      "status":"cancelled",
      "cancelledOrders":[
         {
            "order_id":"6180adfa-e4b1-4a52-adac-ea5417620dbd"
         },
         {
            "order_id":"89e3edbe-d739-4c52-b866-6f5a8407ff6e"
         },
         {
            "order_id":"0cd37a77-1644-4960-a7fb-9a1f6e0e46f7"
         }
      ],
      "orderEvents":[
         {
            "uid":"6180adfa-e4b1-4a52-adac-ea5417620dbd",
            "order":{
               "orderId":"6180adfa-e4b1-4a52-adac-ea5417620dbd",
               "cliOrdId":null,
               "type":"stp",
               "symbol":"pi_xbtusd",
               "side":"buy",
               "quantity":1000,
               "filled":0,
               "limitPrice":10039,
               "stopPrice":10039,
               "reduceOnly":false,
               "timestamp":"2019-08-01T15:57:19.482Z"
            },
            "type":"CANCEL"
         },
         {
            "uid":"89e3edbe-d739-4c52-b866-6f5a8407ff6e",
            "order":{
               "orderId":"89e3edbe-d739-4c52-b866-6f5a8407ff6e",
               "cliOrdId":null,
               "type":"post",
               "symbol":"pi_xbtusd",
               "side":"buy",
               "quantity":890,
               "filled":0,
               "limitPrice":10040,
               "stopPrice":null,
               "reduceOnly":false,
               "timestamp":"2019-08-01T15:57:08.508Z"
            },
            "type":"CANCEL"
         },
         {
            "uid":"0cd37a77-1644-4960-a7fb-9a1f6e0e46f7",
            "order":{
               "orderId":"0cd37a77-1644-4960-a7fb-9a1f6e0e46f7",
               "cliOrdId":null,
               "type":"lmt",
               "symbol":"pi_xbtusd",
               "side":"sell",
               "quantity":900,
               "filled":0,
               "limitPrice":10145,
               "stopPrice":null,
               "reduceOnly":true,
               "timestamp":"2019-08-01T15:57:14.003Z"
            },
            "type":"CANCEL"
         }
      ]
   },
   "serverTime":"2019-08-01T15:57:37.520Z"
}

Field	Type	Description
result	String	Always success
serverTime	ISO8601 datetime	The server date and time
cancelStatus	structure	A structure containing information on the cancellation request, see below
receivedTime	ISO8601 datetime	The date and time the order cancellation was received
cancelOnly	string	The symbol of the futures or all.
status	string	The status of the order cancellation, either of: cancelled: successful cancellation noOrdersToCancel: no open orders for cancellation
cancelledOrders	list of structures	A list of structures containing all the successfully cancelled orders
order_id	string	The cancelled order id
cliOrdId	string	The client order id. Returned only if client specified one
orderEvents	Structure	Order Events

Sample Return if Unsuccessful

{
"result":"error",
"serverTime":"2016-02-25T09:45:53.818Z",
"error":"apiLimitExceeded"
}

Field	Type	Description
result	String	Always error
serverTime	ISO8601 datetime	The server date and time
error	string	The reason the API call failed, either of: apiLimitExceeded: the API limit for the calling IP address has been exceeded authenticationError: the request could not be authenticated invalidArgument: the specified future symbol is invalid nonceBelowThreshold: <threshold> the provided nonce is below the <threshold> nonceDuplicate: <duplicate> the provided nonce is a duplicate as it has been used in a previous request

Articles in this section