This endpoint provides a Dead Man's Switch mechanism to protect the user from network malfunctions. The user can send a request with a timeout in seconds which will trigger a countdown timer that will cancel all user orders when timeout expires. The user has to keep sending request to push back the timeout expiration or they can deactivate the mechanism by specifying a timeout of zero (0).
The recommended mechanism usage is making a call every 15 to 20 seconds and provide a timeout of 60 seconds. This allows the user to keep the orders in place on a brief network failure, while keeping them safe in case of a network breakdown.
Authentication is required.
|
Endpoint |
Request Type | Permissible API Keys |
|
/api/v3/cancelallordersafter
|
POST | Read-write, Master |
| Argument | Type | Required | Description |
|
timeout
|
positive integer | Yes | The timeout specified in seconds. |
| Sample Call |
|
https://www.cryptofacilities.com/derivatives/api/v3/cancelorderallordersafter?timeout=60 https://www.cryptofacilities.com/derivatives/api/v3/cancelorderallordersafter?timeout=0 |
| Sample Return if Successful |
|
{ { |
|
Field |
Type | Description |
|
result
|
String | Always success |
|
serverTime
|
ISO8601 datetime | The server date and time |
|
status
|
structure | The status of the switch |
| currentTime | ISO8601 datetime | The server date and time that server received the request |
| triggerTime | ISO8601 datetime | The server date and time that the switch will be activated |
| 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:
|