Dead man's switch

POST 
/cancelallordersafter

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.

Request

application/json

Body

required

timeout number

The timeout specified in seconds.

Responses

200

application/json

Schema

Schema

oneOf

Success Response

status object

The status of the switch.

currentTime string

The server date and time that server received the request.

triggerTime string

The server date and time that the switch will be activated.

result stringrequired

Possible values: [success]

serverTime date-timerequired

Server time in Coordinated Universal Time (UTC)

ErrorResponse

errors Error (string)[]

Possible values: [accountInactive, apiLimitExceeded, authenticationError, insufficientFunds, invalidAccount, invalidAmount, invalidArgument, invalidUnit, Json Parse Error, marketUnavailable, nonceBelowThreshold, nonceDuplicate, notFound, requiredArgumentMissing, Server Error, Unavailable, unknownError]

error Error (string)

Possible values: [accountInactive, apiLimitExceeded, authenticationError, insufficientFunds, invalidAccount, invalidAmount, invalidArgument, invalidUnit, Json Parse Error, marketUnavailable, nonceBelowThreshold, nonceDuplicate, notFound, requiredArgumentMissing, Server Error, Unavailable, unknownError]

Error description.

• accountInactive: The Futures account the request refers to is inactive
• apiLimitExceeded: The API limit for the calling IP address has been exceeded
• authenticationError: The request could not be authenticated
• insufficientFunds: The amount requested for transfer is below the amount of funds available
• invalidAccount: The Futures account the transfer request refers to is invalid
• invalidAmount: The amount the transfer request refers to is invalid
• invalidArgument: One or more arguments provided are invalid
• invalidUnit: The unit the transfer request refers to is invalid
• Json Parse Error: The request failed to pass valid JSON as an argument
• marketUnavailable: The market is currently unavailable
• nonceBelowThreshold: The provided nonce is below the threshold
• nonceDuplicate: The provided nonce is a duplicate as it has been used in a previous request
• notFound: The requested information could not be found
• requiredArgumentMissing: One or more required arguments are missing
• Server Error: There was an error processing the request
• Unavailable: The endpoint being called is unavailable
• unknownError: An unknown error has occurred

result stringrequired

Possible values: [error]

serverTime date-timerequired

Server time in Coordinated Universal Time (UTC)

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"
}

cancel

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

failure

{
  "result": "error",
  "serverTime": "2016-02-25T09:45:53.818Z",
  "error": "apiLimitExceeded"
}

Loading...