Collateral Account Balance Summary

The endpoint retrieves collateral account balance summary with detailed breakdown per asset.

The API does not cache the response.

Rate limit: 12000 requests/10 sec.

Errors

{
  "code": 30,
  "message": "Validation failed",
  "errors": {
    "ticker": ["ticker is invalid."]
  }
}

POST /api/v4/collateral-account/balance-summary

Collateral Account Balance Summary

cURL

curl --request POST \
  --url https://whitebit.com/api/v4/collateral-account/balance-summary \
  --header 'Content-Type: application/json' \
  --header 'X-TXC-APIKEY: <api-key>' \
  --data '
{
  "ticker": "BTC",
  "request": "{{request}}",
  "nonce": "{{nonce}}"
}
'

import requests

url = "https://whitebit.com/api/v4/collateral-account/balance-summary"

payload = {
    "ticker": "BTC",
    "request": "{{request}}",
    "nonce": "{{nonce}}"
}
headers = {
    "X-TXC-APIKEY": "<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>', 'Content-Type': 'application/json'},
  body: JSON.stringify({ticker: 'BTC', request: '{{request}}', nonce: '{{nonce}}'})
};

fetch('https://whitebit.com/api/v4/collateral-account/balance-summary', 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/collateral-account/balance-summary",
  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([
    'ticker' => 'BTC',
    'request' => '{{request}}',
    'nonce' => '{{nonce}}'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-TXC-APIKEY: <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/collateral-account/balance-summary"

	payload := strings.NewReader("{\n  \"ticker\": \"BTC\",\n  \"request\": \"{{request}}\",\n  \"nonce\": \"{{nonce}}\"\n}")

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

	req.Header.Add("X-TXC-APIKEY", "<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/collateral-account/balance-summary")
  .header("X-TXC-APIKEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"ticker\": \"BTC\",\n  \"request\": \"{{request}}\",\n  \"nonce\": \"{{nonce}}\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://whitebit.com/api/v4/collateral-account/balance-summary")

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["Content-Type"] = 'application/json'
request.body = "{\n  \"ticker\": \"BTC\",\n  \"request\": \"{{request}}\",\n  \"nonce\": \"{{nonce}}\"\n}"

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

200

[
  {
    "asset": "BTC",
    "balance": "0.5",
    "borrow": "0",
    "availableWithoutBorrow": "0.5",
    "availableWithBorrow": "123.456"
  },
  {
    "asset": "USDT",
    "balance": "1000",
    "borrow": "0",
    "availableWithoutBorrow": "1000",
    "availableWithBorrow": "5000"
  }
]

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

Authorizations

X-TXC-APIKEY · string · header · required

API Key authentication for private endpoints.

Required headers:

• X-TXC-APIKEY: API key
• X-TXC-PAYLOAD: Base64 encoded JSON payload
• X-TXC-SIGNATURE: HMAC SHA512 signature

Body

application/json

ticker · string

Filter by requested asset. For example: BTC

If not specified, returns summary for all assets.

Example:

"BTC"

request · string

Request signature

Example:

"{{request}}"

nonce · string

Unique request identifier

Example:

"{{nonce}}"

Response

200

application/json

Successful response - returns detailed balance information per asset

asset · string

Asset ticker symbol

Example:

"BTC"

balance · string

Current balance amount

Example:

"0.5"

borrow · string

Amount currently borrowed

Example:

"0"

availableWithoutBorrow · string

Available balance without using borrow

Example:

"0.5"

availableWithBorrow · string

Available balance including borrowing capacity

Example:

"123.456"