Dead man's switch

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.

POST /cancelallordersafter

Dead man's switch

cURL

curl --request POST \
  --url https://futures.kraken.com/derivatives/api/v3/cancelallordersafter \
  --header 'APIKey: <api-key>' \
  --header 'Authent: <api-key>'

200

success

{
  "result": "success",
  "status": {
    "currentTime": "2018-06-19T16:51:23.839Z",
    "triggerTime": "2018-06-19T16:52:23.839Z"
  },
  "serverTime": "2018-06-19T16:51:23.839Z"
}

Authorizations

APIKey · string · header · required

General API key with full access

Authent · string · header · required

Authentication string

Query Parameters

timeout · number<uint32>

The timeout specified in seconds.

Example:

60

Response

200 - application/json

Success Response

Errors

status · object · required

The status of the switch.

Show child attributes

result · enum<string> · required

Available options: success

Example:

"success"

serverTime · string<date-time> · required

Server time in Coordinated Universal Time (UTC)

Example:

"2020-08-27T17:03:33.196Z"