Collateral Account Summary

POST /api/v4/collateral-account/summary

Collateral Account Summary

cURL

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

import requests

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

payload = {
    "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({request: '{{request}}', nonce: '{{nonce}}'})
};

fetch('https://whitebit.com/api/v4/collateral-account/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/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([
    '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/summary"

	payload := strings.NewReader("{\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/summary")
  .header("X-TXC-APIKEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"request\": \"{{request}}\",\n  \"nonce\": \"{{nonce}}\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://whitebit.com/api/v4/collateral-account/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  \"request\": \"{{request}}\",\n  \"nonce\": \"{{nonce}}\"\n}"

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

200

{
  "equity": "15000.50",
  "margin": "5000.00",
  "freeMargin": "10000.50",
  "unrealizedFunding": "25.75",
  "pnl": "150.25",
  "leverage": 3,
  "marginFraction": "0.3333"
}

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

request · string

Example:

"{{request}}"

nonce · string

Example:

"{{nonce}}"

Response

200

application/json

Successful response - returns collateral account summary

equity · string

Total equity value of the collateral account

Example:

"15000.50"

margin · string

Total margin used

Example:

"5000.00"

freeMargin · string

Available margin for trading

Example:

"10000.50"

unrealizedFunding · string

Unrealized funding payments

Example:

"25.75"

pnl · string

Unrealized profit and loss

Example:

"150.25"

leverage · integer

Current leverage level

Example:

3

marginFraction · string

Margin fraction ratio (margin / equity)

Example:

"0.3333"