Skip to main content

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

Query Parameters

    timeout uint32

    The timeout specified in seconds.

Responses

Schema
    oneOf
    status objectrequired

    The status of the switch.

    currentTime stringrequired

    The server date and time that server received the request.

    triggerTime stringrequired

    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)

Loading...