Back to Website

Articles in this section

See more

Cancel Order

This endpoint allows cancelling an open order for a Futures contract.

Authentication is required.

Endpoint

 Request Type Permissible API Keys
/api/v3/cancelorder
 POST Read-write, Master
Argument Type Required Description
order_id
 UUID No The unique identifier of the order to be cancelled
cliOrdId
 UUID No The client unique identifier of the order to be cancelled
Sample Call

https://www.cryptofacilities.com/derivatives/api/v3/cancelorder?order_id=85c40002-3f20-4e87-9302-262626c3531b
Sample Return if Successful

{  
   "serverTime":"2019-08-01T15:26:30.854Z",
   "result":"success",
   "cancelStatus":{  
      "status":"cancelled",
      "orderEvents":[  
         {  
            "uid":"85c40002-3f20-4e87-9302-262626c3531b",
            "order":{  
               "orderId":"85c40002-3f20-4e87-9302-262626c3531b",
               "cliOrdId":null,
               "type":"lmt",
               "symbol":"pi_xbtusd",
               "side":"buy",
               "quantity":1000,
               "filled":0,
               "limitPrice":10144,
               "stopPrice":null,
               "reduceOnly":false,
               "timestamp":"2019-08-01T15:26:27.790Z"                "algoId":"50ET2ADOS3ZU30ZNW52KS2S100R0SZV" 
                  },
            "type":"CANCEL"
         }
      ]
   }
}

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
status string The status of the order cancellation, either of:
  • cancelled: the order has been cancelled. This may only be part of the order as part may have been filled. Check open_orders websocket feed for status of the order.
  • filled: the order was found completely filled and could not be cancelled
  • notFound: the order was not found, either because it had already been cancelled or it never existed
order_id string The cancelled order id
cliOrdId string The client order id. Shown 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
  • accountInactive: the Crypto Facilities account the request refers to is inactive
  • requiredArgumentMissing: a required argument was missing
  • 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