Collateral stop-limit order

Place a collateral stop-limit order with a specified trigger price via the WhiteBIT V4 API.

POST /api/v4/order/collateral/stop-limit

Collateral Stop-Limit Order

cURL

curl --request POST \
  --url https://whitebit.com/api/v4/order/collateral/stop-limit \
  --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",
  "side": "buy",
  "amount": "0.001",
  "price": "40000",
  "activation_price": "40000",
  "stopLoss": "30000",
  "takeProfit": "50000",
  "client_order_id": "order1987111",
  "positionSide": "LONG",
  "request": "{{request}}",
  "nonce": "{{nonce}}"
}
'

import requests

url = "https://whitebit.com/api/v4/order/collateral/stop-limit"

payload = {
    "market": "BTC_USDT",
    "side": "buy",
    "amount": "0.001",
    "price": "40000",
    "activation_price": "40000",
    "stopLoss": "30000",
    "takeProfit": "50000",
    "client_order_id": "order1987111",
    "positionSide": "LONG",
    "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',
    side: 'buy',
    amount: '0.001',
    price: '40000',
    activation_price: '40000',
    stopLoss: '30000',
    takeProfit: '50000',
    client_order_id: 'order1987111',
    positionSide: 'LONG',
    request: '{{request}}',
    nonce: '{{nonce}}'
  })
};

fetch('https://whitebit.com/api/v4/order/collateral/stop-limit', 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/collateral/stop-limit",
  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',
    'side' => 'buy',
    'amount' => '0.001',
    'price' => '40000',
    'activation_price' => '40000',
    'stopLoss' => '30000',
    'takeProfit' => '50000',
    'client_order_id' => 'order1987111',
    'positionSide' => 'LONG',
    '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/collateral/stop-limit"

	payload := strings.NewReader("{\n  \"market\": \"BTC_USDT\",\n  \"side\": \"buy\",\n  \"amount\": \"0.001\",\n  \"price\": \"40000\",\n  \"activation_price\": \"40000\",\n  \"stopLoss\": \"30000\",\n  \"takeProfit\": \"50000\",\n  \"client_order_id\": \"order1987111\",\n  \"positionSide\": \"LONG\",\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/collateral/stop-limit")
  .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  \"side\": \"buy\",\n  \"amount\": \"0.001\",\n  \"price\": \"40000\",\n  \"activation_price\": \"40000\",\n  \"stopLoss\": \"30000\",\n  \"takeProfit\": \"50000\",\n  \"client_order_id\": \"order1987111\",\n  \"positionSide\": \"LONG\",\n  \"request\": \"{{request}}\",\n  \"nonce\": \"{{nonce}}\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://whitebit.com/api/v4/order/collateral/stop-limit")

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  \"side\": \"buy\",\n  \"amount\": \"0.001\",\n  \"price\": \"40000\",\n  \"activation_price\": \"40000\",\n  \"stopLoss\": \"30000\",\n  \"takeProfit\": \"50000\",\n  \"client_order_id\": \"order1987111\",\n  \"positionSide\": \"LONG\",\n  \"request\": \"{{request}}\",\n  \"nonce\": \"{{nonce}}\"\n}"

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

200

{
  "order_id": 4180284841,
  "client_order_id": "order1987111",
  "market": "BTC_USDT",
  "side": "buy",
  "type": "stop limit",
  "timestamp": 1595792396.165973,
  "deal_money": "0",
  "deal_stock": "0",
  "amount": "0.001",
  "left": "0.001",
  "deal_fee": "0",
  "price": "40000",
  "activation_price": "40000",
  "status": "FILLED",
  "stp": "no",
  "oto": {
    "otoId": 29457221,
    "stopLoss": "30000",
    "takeProfit": "50000"
  },
  "positionSide": "LONG"
}

{
  "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 margin market. Example: BTC_USDT

Example:

"BTC_USDT"

side · enum<string> · required

Order direction. Use buy to open or increase a long position and sell to open or increase a short position.

Available options: buy, sell

Example:

"buy"

amount · string · required

Amount of stock currency to buy or sell. Minimum and step values are market-dependent — query the market info endpoint for constraints.

Example:

"0.001"

price · string · required

Limit order price in money currency. The order executes at the specified price or better after activation.

Example:

"40000"

activation_price · string · required

Trigger price in money currency. The stop-limit order activates when the market price reaches the specified value.

Example:

"40000"

request · string · required

Example:

"{{request}}"

nonce · string · required

Example:

"{{nonce}}"

stopLoss · string

Stop loss price.

When provided, the system creates an OTO order with a stop loss condition.

Example:

"30000"

takeProfit · string

Take profit price.

When provided, the system creates an OTO order with a take profit condition.

Example:

"50000"

client_order_id · string

Custom order identifier. Must be unique and contain only letters, numbers, dashes, dots, or underscores.

Example:

"order1987111"

positionSide · enum<string>

Defines the position direction when hedge mode is enabled. See positionSide

Available options: LONG, SHORT, BOTH

Example:

"LONG"

Response

200

application/json

Successful response - stop-limit order created

order_id · integer

Unique order identifier

Example:

4180284841

client_order_id · string

Custom client order identifier. Empty string if not specified

Example:

"order1987111"

market · string

Market name

Example:

"BTC_USDT"

side · enum<string>

Order side

Available options: buy, sell

Example:

"buy"

type · string

Order type

Example:

"stop limit"

timestamp · number

Unix timestamp in seconds (UTC) of order creation, with microsecond precision.

Example:

1595792396.165973

deal_money · string

Amount in money currency that is finished

Example:

"0"

deal_stock · string

Amount in stock currency that is finished

Example:

"0"

amount · string

Order amount

Example:

"0.001"

left · string

Remaining amount that must be finished

Example:

"0.001"

deal_fee · string

Fee in money that is paid when order is finished

Example:

"0"

price · string

Order price

Example:

"40000"

activation_price · string

Price at which the stop-limit order activates

Example:

"40000"

status · enum<string>

Order status

Available options: NEW, FILLED, PARTIALLY_FILLED, CANCELLED

Example:

"FILLED"

stp · string

Self trade prevention mode

Example:

"no"

oto · object | null

OTO order data when stopLoss or takeProfit is specified

Show child attributes

positionSide · enum<string>

Position side

Available options: LONG, SHORT, BOTH

Example:

"LONG"