Collateral bulk limit order

Place multiple collateral limit orders in a single request via the WhiteBIT V4 API.

POST /api/v4/order/collateral/bulk

Collateral bulk limit order

cURL

curl --request POST \
  --url https://whitebit.com/api/v4/order/collateral/bulk \
  --header 'Content-Type: application/json' \
  --header 'X-TXC-APIKEY: <api-key>' \
  --header 'X-TXC-PAYLOAD: <api-key>' \
  --header 'X-TXC-SIGNATURE: <api-key>' \
  --data '
{
  "orders": [
    {
      "side": "buy",
      "amount": "0.02",
      "price": "40000",
      "market": "BTC_PERP",
      "postOnly": false,
      "ioc": false,
      "client_order_id": "",
      "positionSide": "LONG",
      "rpi": true,
      "reduceOnly": false
    },
    {
      "side": "sell",
      "amount": "0.0001",
      "price": "41000",
      "market": "BTC_USDT",
      "postOnly": false,
      "ioc": false,
      "client_order_id": "",
      "positionSide": "LONG",
      "rpi": true,
      "reduceOnly": true
    },
    {
      "side": "sell",
      "amount": "0.02",
      "price": "0.030",
      "market": "ETH_BTC",
      "postOnly": false,
      "ioc": false,
      "client_order_id": "",
      "positionSide": "LONG",
      "rpi": true,
      "reduceOnly": false
    }
  ],
  "stopOnFail": true,
  "request": "{{request}}",
  "nonce": "{{nonce}}"
}
'

import requests

url = "https://whitebit.com/api/v4/order/collateral/bulk"

payload = {
    "orders": [
        {
            "side": "buy",
            "amount": "0.02",
            "price": "40000",
            "market": "BTC_PERP",
            "postOnly": False,
            "ioc": False,
            "client_order_id": "",
            "positionSide": "LONG",
            "rpi": True,
            "reduceOnly": False
        },
        {
            "side": "sell",
            "amount": "0.0001",
            "price": "41000",
            "market": "BTC_USDT",
            "postOnly": False,
            "ioc": False,
            "client_order_id": "",
            "positionSide": "LONG",
            "rpi": True,
            "reduceOnly": True
        },
        {
            "side": "sell",
            "amount": "0.02",
            "price": "0.030",
            "market": "ETH_BTC",
            "postOnly": False,
            "ioc": False,
            "client_order_id": "",
            "positionSide": "LONG",
            "rpi": True,
            "reduceOnly": False
        }
    ],
    "stopOnFail": True,
    "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({
    orders: [
      {
        side: 'buy',
        amount: '0.02',
        price: '40000',
        market: 'BTC_PERP',
        postOnly: false,
        ioc: false,
        client_order_id: '',
        positionSide: 'LONG',
        rpi: true,
        reduceOnly: false
      },
      {
        side: 'sell',
        amount: '0.0001',
        price: '41000',
        market: 'BTC_USDT',
        postOnly: false,
        ioc: false,
        client_order_id: '',
        positionSide: 'LONG',
        rpi: true,
        reduceOnly: true
      },
      {
        side: 'sell',
        amount: '0.02',
        price: '0.030',
        market: 'ETH_BTC',
        postOnly: false,
        ioc: false,
        client_order_id: '',
        positionSide: 'LONG',
        rpi: true,
        reduceOnly: false
      }
    ],
    stopOnFail: true,
    request: '{{request}}',
    nonce: '{{nonce}}'
  })
};

fetch('https://whitebit.com/api/v4/order/collateral/bulk', 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/bulk",
  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([
    'orders' => [
        [
                'side' => 'buy',
                'amount' => '0.02',
                'price' => '40000',
                'market' => 'BTC_PERP',
                'postOnly' => false,
                'ioc' => false,
                'client_order_id' => '',
                'positionSide' => 'LONG',
                'rpi' => true,
                'reduceOnly' => false
        ],
        [
                'side' => 'sell',
                'amount' => '0.0001',
                'price' => '41000',
                'market' => 'BTC_USDT',
                'postOnly' => false,
                'ioc' => false,
                'client_order_id' => '',
                'positionSide' => 'LONG',
                'rpi' => true,
                'reduceOnly' => true
        ],
        [
                'side' => 'sell',
                'amount' => '0.02',
                'price' => '0.030',
                'market' => 'ETH_BTC',
                'postOnly' => false,
                'ioc' => false,
                'client_order_id' => '',
                'positionSide' => 'LONG',
                'rpi' => true,
                'reduceOnly' => false
        ]
    ],
    'stopOnFail' => true,
    '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/bulk"

	payload := strings.NewReader("{\n  \"orders\": [\n    {\n      \"side\": \"buy\",\n      \"amount\": \"0.02\",\n      \"price\": \"40000\",\n      \"market\": \"BTC_PERP\",\n      \"postOnly\": false,\n      \"ioc\": false,\n      \"client_order_id\": \"\",\n      \"positionSide\": \"LONG\",\n      \"rpi\": true,\n      \"reduceOnly\": false\n    },\n    {\n      \"side\": \"sell\",\n      \"amount\": \"0.0001\",\n      \"price\": \"41000\",\n      \"market\": \"BTC_USDT\",\n      \"postOnly\": false,\n      \"ioc\": false,\n      \"client_order_id\": \"\",\n      \"positionSide\": \"LONG\",\n      \"rpi\": true,\n      \"reduceOnly\": true\n    },\n    {\n      \"side\": \"sell\",\n      \"amount\": \"0.02\",\n      \"price\": \"0.030\",\n      \"market\": \"ETH_BTC\",\n      \"postOnly\": false,\n      \"ioc\": false,\n      \"client_order_id\": \"\",\n      \"positionSide\": \"LONG\",\n      \"rpi\": true,\n      \"reduceOnly\": false\n    }\n  ],\n  \"stopOnFail\": true,\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/bulk")
  .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  \"orders\": [\n    {\n      \"side\": \"buy\",\n      \"amount\": \"0.02\",\n      \"price\": \"40000\",\n      \"market\": \"BTC_PERP\",\n      \"postOnly\": false,\n      \"ioc\": false,\n      \"client_order_id\": \"\",\n      \"positionSide\": \"LONG\",\n      \"rpi\": true,\n      \"reduceOnly\": false\n    },\n    {\n      \"side\": \"sell\",\n      \"amount\": \"0.0001\",\n      \"price\": \"41000\",\n      \"market\": \"BTC_USDT\",\n      \"postOnly\": false,\n      \"ioc\": false,\n      \"client_order_id\": \"\",\n      \"positionSide\": \"LONG\",\n      \"rpi\": true,\n      \"reduceOnly\": true\n    },\n    {\n      \"side\": \"sell\",\n      \"amount\": \"0.02\",\n      \"price\": \"0.030\",\n      \"market\": \"ETH_BTC\",\n      \"postOnly\": false,\n      \"ioc\": false,\n      \"client_order_id\": \"\",\n      \"positionSide\": \"LONG\",\n      \"rpi\": true,\n      \"reduceOnly\": false\n    }\n  ],\n  \"stopOnFail\": true,\n  \"request\": \"{{request}}\",\n  \"nonce\": \"{{nonce}}\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"orders\": [\n    {\n      \"side\": \"buy\",\n      \"amount\": \"0.02\",\n      \"price\": \"40000\",\n      \"market\": \"BTC_PERP\",\n      \"postOnly\": false,\n      \"ioc\": false,\n      \"client_order_id\": \"\",\n      \"positionSide\": \"LONG\",\n      \"rpi\": true,\n      \"reduceOnly\": false\n    },\n    {\n      \"side\": \"sell\",\n      \"amount\": \"0.0001\",\n      \"price\": \"41000\",\n      \"market\": \"BTC_USDT\",\n      \"postOnly\": false,\n      \"ioc\": false,\n      \"client_order_id\": \"\",\n      \"positionSide\": \"LONG\",\n      \"rpi\": true,\n      \"reduceOnly\": true\n    },\n    {\n      \"side\": \"sell\",\n      \"amount\": \"0.02\",\n      \"price\": \"0.030\",\n      \"market\": \"ETH_BTC\",\n      \"postOnly\": false,\n      \"ioc\": false,\n      \"client_order_id\": \"\",\n      \"positionSide\": \"LONG\",\n      \"rpi\": true,\n      \"reduceOnly\": false\n    }\n  ],\n  \"stopOnFail\": true,\n  \"request\": \"{{request}}\",\n  \"nonce\": \"{{nonce}}\"\n}"

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

200

[
  {
    "result": {
      "order_id": 4326248250,
      "client_order_id": "",
      "market": "BTC_USDT",
      "side": "buy",
      "type": "limit",
      "timestamp": 1684916268.825564,
      "deal_money": "641.988",
      "deal_stock": "0.02",
      "amount": "0.02",
      "left": "0",
      "deal_fee": "1.283976",
      "ioc": false,
      "postOnly": false,
      "price": "40000",
      "status": "FILLED",
      "stp": "no",
      "positionSide": "LONG",
      "rpi": true,
      "reduceOnly": false
    },
    "error": null
  },
  {
    "result": null,
    "error": {
      "code": 32,
      "message": "Validation failed",
      "errors": {
        "amount": [
          "Given amount is less than min amount 0.001."
        ]
      }
    }
  },
  {
    "result": {
      "order_id": 4326248250,
      "client_order_id": "",
      "market": "BTC_USDT",
      "side": "sell",
      "type": "limit",
      "timestamp": 1684916268.825564,
      "deal_money": "641.988",
      "deal_stock": "0.02",
      "amount": "0.02",
      "left": "0",
      "deal_fee": "1.283976",
      "ioc": false,
      "postOnly": false,
      "price": "41000",
      "status": "FILLED",
      "stp": "no",
      "positionSide": "LONG",
      "rpi": true,
      "reduceOnly": false
    },
    "error": null
  }
]

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

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

The reduceOnly parameter documented on this page is coming soon. The documentation is published in advance for integration planning. The parameter is not yet accepted by the API. See Reduce-only orders for details.

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

orders · object[]

Show child attributes

stopOnFail · boolean · default: false

Controls how the bulk order processor handles failures.

When true: Processing stops at the first order that fails validation or execution. Only orders up to (but not including) the failed order are processed.

When false (default): All orders in the bulk request are processed regardless of individual failures. Each order result is returned in the response array.

Example:

true

request · string

Example:

"{{request}}"

nonce · string

Example:

"{{nonce}}"

Response

200

application/json

Successful response - returns array of order results

result · object | null

Order data when successful, null when failed

Show child attributes

error · object | null

Error details when order creation failed, null when successful

Show child attributes