Query unexecuted (active) conditional orders

List active conditional orders not yet triggered on collateral markets via the V4 API.

POST /api/v4/orders/conditional

Query unexecuted(active) conditional orders

cURL

curl --request POST \
  --url https://whitebit.com/api/v4/orders/conditional \
  --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",
  "offset": 0,
  "limit": 100
}
'

import requests

url = "https://whitebit.com/api/v4/orders/conditional"

payload = {
    "market": "BTC_USDT",
    "offset": 0,
    "limit": 100
}
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', offset: 0, limit: 100})
};

fetch('https://whitebit.com/api/v4/orders/conditional', 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/orders/conditional",
  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',
    'offset' => 0,
    'limit' => 100
  ]),
  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/orders/conditional"

	payload := strings.NewReader("{\n  \"market\": \"BTC_USDT\",\n  \"offset\": 0,\n  \"limit\": 100\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/orders/conditional")
  .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  \"offset\": 0,\n  \"limit\": 100\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://whitebit.com/api/v4/orders/conditional")

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  \"offset\": 0,\n  \"limit\": 100\n}"

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

200

{
  "limit": 100,
  "offset": 0,
  "total": 2,
  "records": [
    {
      "id": 117703764513,
      "type": "oco",
      "reduceOnly": false,
      "stop_loss": {
        "order_id": 117703764514,
        "client_order_id": "",
        "market": "BTC_USDT",
        "side": "buy",
        "type": "stop limit",
        "timestamp": 1594605801.49815,
        "deal_money": "0",
        "deal_stock": "0",
        "amount": "2.241379",
        "takerFee": "0.001",
        "makerFee": "0.001",
        "left": "2.241379",
        "deal_fee": "0",
        "post_only": false,
        "mtime": 1662478154.941582,
        "price": "19928.79",
        "activation_price": "29928.79",
        "activation_condition": "gte",
        "activated": 0,
        "status": "FILLED",
        "stp": "no",
        "positionSide": "LONG"
      },
      "take_profit": {
        "order_id": 117703764515,
        "client_order_id": "",
        "market": "BTC_USDT",
        "side": "buy",
        "type": "limit",
        "timestamp": 1662478154.941582,
        "deal_money": "0",
        "deal_stock": "0",
        "amount": "0.635709",
        "takerFee": "0.001",
        "makerFee": "0.001",
        "left": "0.635709",
        "deal_fee": "0",
        "post_only": false,
        "mtime": 1662478154.941582,
        "price": "9928.79",
        "status": "FILLED",
        "stp": "no",
        "positionSide": "LONG"
      }
    },
    {
      "id": 29457221,
      "type": "oto",
      "reduceOnly": false,
      "stopLossPrice": "30000",
      "takeProfitPrice": "50000",
      "conditionalOrder": {
        "order_id": 3686033640,
        "client_order_id": "customId11",
        "market": "BTC_USDT",
        "side": "buy",
        "type": "limit",
        "timestamp": 1594605801.49815,
        "deal_money": "0",
        "deal_stock": "0",
        "amount": "2.241379",
        "takerFee": "0.001",
        "makerFee": "0.001",
        "left": "2.241379",
        "deal_fee": "0",
        "price": "40000",
        "status": "FILLED",
        "stp": "no",
        "positionSide": "LONG"
      }
    }
  ]
}

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

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

The reduceOnly response field documented on this page is coming soon. The documentation is published in advance for integration planning. The field is not yet returned 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

market · string

Filter by specific market. Example: BTC_USDT

If not specified, returns conditional orders for all markets.

Example:

"BTC_USDT"

offset · integer · default: 0

Number of records to skip for pagination.

Example:

0

limit · integer · default: 50

Maximum number of records to return per page.

Example:

100

request · string

Example:

"{{request}}"

nonce · string

Example:

"{{nonce}}"

Response

200

application/json

Successful response - returns paginated conditional orders (OCO and OTO types)

limit · integer

Number of records per page

Example:

100

offset · integer

Number of records skipped

Example:

0

total · integer

Total number of records

Example:

2

records · object[]

Array of conditional orders (can be OCO or OTO type)

OCO type conditional order

Option 1

Option 2

Show child attributes