Skip to main content
POST
/
api
/
v4
/
order
/
kill-switch
Sync kill-switch timer
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}}"
}
'
{
  "market": "BTC_USDT",
  "startTime": 1662478154,
  "cancellationTime": 1662478154,
  "types": [
    "spot",
    "margin"
  ]
}

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

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