Sync kill-switch timer

Set or reset a kill-switch timer for automatic cancellation of 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>' \
  --header 'X-TXC-PAYLOAD: <api-key>' \
  --header 'X-TXC-SIGNATURE: <api-key>' \
  --data '
{
  "market": "BTC_USDT",
  "timeout": "60",
  "types": [
    "spot",
    "margin"
  ],
  "request": "{{request}}",
  "nonce": "{{nonce}}"
}
'

import requests

url = "https://whitebit.com/api/v4/order/kill-switch"

payload = {
    "market": "BTC_USDT",
    "timeout": "60",
    "types": ["spot", "margin"],
    "request": "{{request}}",
    "nonce": "{{nonce}}"
}
headers = {
    "X-TXC-APIKEY": "<api-key>",
    "X-TXC-PAYLOAD": "<api-key>",
    "X-TXC-SIGNATURE": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-TXC-APIKEY': '<api-key>',
    'X-TXC-PAYLOAD': '<api-key>',
    'X-TXC-SIGNATURE': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    market: 'BTC_USDT',
    timeout: '60',
    types: ['spot', 'margin'],
    request: '{{request}}',
    nonce: '{{nonce}}'
  })
};

fetch('https://whitebit.com/api/v4/order/kill-switch', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://whitebit.com/api/v4/order/kill-switch",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'market' => 'BTC_USDT',
    'timeout' => '60',
    'types' => [
        'spot',
        'margin'
    ],
    'request' => '{{request}}',
    'nonce' => '{{nonce}}'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-TXC-APIKEY: <api-key>",
    "X-TXC-PAYLOAD: <api-key>",
    "X-TXC-SIGNATURE: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://whitebit.com/api/v4/order/kill-switch"

	payload := strings.NewReader("{\n  \"market\": \"BTC_USDT\",\n  \"timeout\": \"60\",\n  \"types\": [\n    \"spot\",\n    \"margin\"\n  ],\n  \"request\": \"{{request}}\",\n  \"nonce\": \"{{nonce}}\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-TXC-APIKEY", "<api-key>")
	req.Header.Add("X-TXC-PAYLOAD", "<api-key>")
	req.Header.Add("X-TXC-SIGNATURE", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://whitebit.com/api/v4/order/kill-switch")
  .header("X-TXC-APIKEY", "<api-key>")
  .header("X-TXC-PAYLOAD", "<api-key>")
  .header("X-TXC-SIGNATURE", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"market\": \"BTC_USDT\",\n  \"timeout\": \"60\",\n  \"types\": [\n    \"spot\",\n    \"margin\"\n  ],\n  \"request\": \"{{request}}\",\n  \"nonce\": \"{{nonce}}\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://whitebit.com/api/v4/order/kill-switch")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-TXC-APIKEY"] = '<api-key>'
request["X-TXC-PAYLOAD"] = '<api-key>'
request["X-TXC-SIGNATURE"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"market\": \"BTC_USDT\",\n  \"timeout\": \"60\",\n  \"types\": [\n    \"spot\",\n    \"margin\"\n  ],\n  \"request\": \"{{request}}\",\n  \"nonce\": \"{{nonce}}\"\n}"

response = http.request(request)
puts response.read_body

200

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

{
  "code": 30,
  "message": "Validation failed",
  "errors": {}
}

{
  "code": 30,
  "message": "Validation failed",
  "errors": {}
}

Authorizations

X-TXC-APIKEY · string · header · required

The public WhiteBIT API key.

X-TXC-PAYLOAD · string · header · required

Base64-encoded JSON request body.

X-TXC-SIGNATURE · string · header · required

HMAC-SHA512 signature of the payload, hex-encoded. Computed as hex(HMAC-SHA512(payload, api_secret)).

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 to target. Valid values: "spot" — standard spot orders. "margin" — marginal orders placed on spot markets. Note: the "margin" value is not the same as the collateral account balance; "collateral" in other endpoints refers to the funding account, whereas "margin" here refers specifically to the order type. "futures" — marginal orders placed on futures markets (e.g., BTC_PERP). If omitted, the API targets all order types.

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