Sync kill-switch timer

Set or reset a kill-switch timer that automatically cancels all spot orders after a timeout.

POST /api/v4/order/kill-switch

Sync kill-switch timer

cURL

curl --request POST \
  --url https://whitebit.com/api/v4/order/kill-switch \
  --header 'Content-Type: application/json' \
  --header 'X-TXC-APIKEY: <api-key>' \
  --data '
{
  "market": "BTC_USDT",
  "timeout": "60",
  "types": [
    "spot",
    "margin"
  ],
  "request": "{{request}}",
  "nonce": "{{nonce}}"
}
'

200

{
  "market": "BTC_USDT",
  "startTime": 1662478154,
  "cancellationTime": 1662478154,
  "types": [
    "spot",
    "margin"
  ]
}

Authorizations

X-TXC-APIKEY · string · header · required

API Key authentication for private endpoints.

Required headers:

• X-TXC-APIKEY: API key
• X-TXC-PAYLOAD: Base64 encoded JSON payload
• X-TXC-SIGNATURE: HMAC SHA512 signature

Body

application/json

market · string · required

Available market. Example: BTC_USDT

Example:

"BTC_USDT"

timeout · string · required

Timer value. Example: '5'-'600' or null

Example:

"60"

types · enum<string>[]

Order types value. Example: 'spot', 'margin', 'futures' or null

Available options: spot, margin, futures

Example:

["spot", "margin"]

request · string

Example:

"{{request}}"

nonce · string

Example:

"{{nonce}}"

Response

200

application/json

Successful response - kill-switch timer synced

market · string

Market name

Example:

"BTC_USDT"

startTime · integer

Timer start timestamp

Example:

1662478154

cancellationTime · integer

Order cancellation timestamp (startTime + timeout)

Example:

1662478154

types · enum<string>[]

Order types affected by kill-switch

Available options: spot, margin, futures

Example:

["spot", "margin"]