Back to Website

Articles in this section

See more

Cancel All Orders

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":"2021-07-14T15:09:01.333Z",
   "cancelOnly":"fi_xbtusd",
   "status":"cancelled",
   "cancelledOrders":[
           {
            "order_id":"05e46ed5-a91b-4773-ab51-24ca5d3c4aee"
            },
            {
            "order_id":"2018bc94-643c-477e-9368-8a5688396c6a"
            },
            {
            "order_id":"c86621d1-056a-4e34-b0bf-1bf536f7f557"
            },

        ],
        "orderEvents":[
              {
               "uid":"05e46ed5-a91b-4773-ab51-24ca5d3c4aee",
                  "order":{
                      "orderId":"05e46ed5-a91b-4773-ab51-24ca5d3c4aee",
                      "cliOrdId":null,
                      "type":"lmt",
                      "symbol":"pi_xbtusd",
                      "side":"buy",
                      "quantity":10.0,
                      "filled":0,
                      "limitPrice":31200.0,
                      "reduceOnly":false,
                      "timestamp":"2021-07-13T18:45:56.554Z",
                      "lastUpdateTimestamp":"2021-07-13T18:45:56.554Z",
                      "algoId":"50ET2ADOS3ZU30ZNW52KS2S100R0SZV"},
                      "type":"CANCEL"},
             {
               "uid":"2018bc94-643c-477e-9368-8a5688396c6a",
                 "order":{

                       "orderId":"2018bc94-643c-477e-9368-8a5688396c6a",
                       "cliOrdId":null,
                       "type":"lmt",
                       "symbol":"pi_xbtusd",
                       "side":"buy",
                       "quantity":1000,
                       "filled":0,
                       "limitPrice":29000,
                       "reduceOnly":false,
                       "timestamp":"2021-07-13T19:13:41.407Z",
                       "lastUpdateTimestamp":"2021-07-13T19:13:41.407Z",
                       "algoId":"50ET2ADOS3ZU30ZNW52KS2S100R0SZV"
                       },

                    "type":"CANCEL"
                      },
             {
               "uid":"c86621d1-056a-4e34-b0bf-1bf536f7f557",
                 "order":{
                       "orderId":"c86621d1-056a-4e34-b0bf-1bf536f7f557",
                       "cliOrdId":null,
                       "type":"lmt",
                       "symbol":"pi_xbtusd",
                       "side":"buy",
                       "quantity":1000,
                       "filled":0,
                       "limitPrice":29000,
                       "reduceOnly":false,
                       "timestamp":"2021-07-13T19:07:51.045Z",
                       "lastUpdateTimestamp":"2021-07-13T19:07:51.045Z
                       "algoId":"50ET2ADOS3ZU30ZNW52KS2S100R0SZV"
                      },
                    "type":"CANCEL"
                      },
                   ]
          },
      "serverTime":"2021-07-14T15:09:01.336Z"
}

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