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 |
{ |
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:
|
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:
|