API Reference - WhiteBIT

Base URL

All REST API endpoints are available at:

https://whitebit.com/api/v4/{endpoint}

Public endpoints use the GET method and accept parameters as query strings.
Private endpoints use the POST method and accept parameters as JSON in the request body.
All endpoints return time in Unix-time format and respond with JSON.

Quickstart

Prerequisites

A WhiteBIT account (Sign up)
An API key with appropriate permissions (API Settings)
A programming language or HTTP client (cURL, Python, JavaScript, or similar)

Step 1: First public API call

The Server Status endpoint returns the API life-state. No authentication is required. Request:

cURL
Python
JavaScript

curl -X GET "https://whitebit.com/api/v4/public/ping"

import requests

response = requests.get("https://whitebit.com/api/v4/public/ping")
print(response.json())

const response = await fetch("https://whitebit.com/api/v4/public/ping");
const data = await response.json();
console.log(data);

Expected response:

["pong"]

A response of ["pong"] confirms the API is operational.

Step 2: Authentication setup

Private endpoints require HMAC-SHA512 signed requests. See the Authentication guide for the full signing process. Required headers for private endpoints:

Header	Value
`Content-type`	`application/json`
`X-TXC-APIKEY`	The public API key
`X-TXC-PAYLOAD`	Base64-encoded request body
`X-TXC-SIGNATURE`	HMAC-SHA512 signature (hex encoded)

Step 3: First authenticated API call

The Main Balance endpoint retrieves the main account balance. The request body must include request (the endpoint path) and nonce (unique identifier). Request body:

{
  "request": "/api/v4/main-account/balance",
  "nonce": 1594297865000
}

Example with cURL (replace YOUR_API_KEY and YOUR_SIGNATURE with the signed payload):

curl -X POST "https://whitebit.com/api/v4/main-account/balance" \
  -H "Content-type: application/json" \
  -H "X-TXC-APIKEY: YOUR_API_KEY" \
  -H "X-TXC-PAYLOAD: BASE64_ENCODED_PAYLOAD" \
  -H "X-TXC-SIGNATURE: YOUR_SIGNATURE" \
  -d '{"request":"/api/v4/main-account/balance","nonce":1594297865000}'

For a runnable signing implementation in Python, see First API Call. Expected response:

{
  "BTC": { "main_balance": "0" },
  "USDT": { "main_balance": "100.50" }
}

The response contains balance data for each asset. Omitted assets have a zero balance.

Rate Limits

For complete rate limits, error codes, and best practices, see Rate Limits & Error Codes.

Error Format

All V4 endpoints return errors as JSON. The format differs slightly between public and private APIs: Public endpoints:

{
  "success": false,
  "message": "ERROR MESSAGE",
  "params": []
}

Private endpoints:

{
  "code": 0,
  "message": "MESSAGE",
  "errors": {
    "PARAM1": ["MESSAGE"],
    "PARAM2": ["MESSAGE"]
  }
}

HTTP Status Codes

For retry strategies, authentication errors, and best practices, see Rate Limits & Error Codes.

Endpoint Groups

Market Data

Public market info, orderbook, trades, fees, server status, and more. No authentication required. See Markets & Trading Pairs for pair notation.

Trading

Spot and collateral (margin/futures) trading: orders, order queries, positions, leverage, hedge mode, and kill-switch timers.

Convert

Estimate, confirm, and review currency conversion operations.

Account & Wallet

Main balance, deposits, withdrawals, transfers, codes, crypto lending, and fees. See Balances & Transfers for account types.

Travel Rule

VASP directory and deposit verification for Travel Rule compliance on crypto transfers.

Sub-Accounts

Create and manage sub-accounts, balances, transfers, and API keys.

Mining Pool

Monitor mining operations, manage payouts, track worker performance, and create watcher links.

Address Checker

Screen blockchain addresses for AML risk before crediting deposits or sending withdrawals.

OAuth

Third-party authorization: token exchange, refresh, OAuth API keys, and account endpoints.

What’s next

Authentication — Full signing process and common errors
Rate Limits & Error Codes — Per-endpoint limits, error formats, and troubleshooting
Market Data — Public endpoints for orderbook, trades, and market info
Trading — Spot and collateral orders, queries, and positions
WebSocket API — Real-time market data and account streams, plus order management from September 2, 2026 (global platform only)
SDKs — Official Go, Python, and PHP SDKs

Used in these guides

Partner Solutions — the partner router that maps use cases to programs.

​Base URL

​Quickstart

​Prerequisites

​Step 1: First public API call

​Step 2: Authentication setup

​Step 3: First authenticated API call

​Rate Limits

​Error Format

​HTTP Status Codes

​Endpoint Groups