Base URL
All REST API endpoints are available at:- Public endpoints use the
GETmethod and accept parameters as query strings. - Private endpoints use the
POSTmethod 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
["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. WhiteBIT provides the API Quick Start Helper with examples in Python, PHP, Node.js, Go, JavaScript, Kotlin, .NET, Ruby, C++, and Rust. 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 includerequest (the endpoint path) and nonce (unique identifier).
Request body:
YOUR_API_KEY and YOUR_SIGNATURE with the signed payload):
- cURL
- Python (with helper)
Rate Limits
| Scope | Limit |
|---|---|
| Public REST endpoints | 2000 requests / 10 sec |
| Private REST endpoints | Varies per endpoint (see individual docs) |
Error Format
All V4 endpoints return errors as JSON. The format differs slightly between public and private APIs: Public endpoints:Endpoint Groups
Market Data
Public market info, orderbook, trades, fees, server status, and more. No authentication required.
Spot Trading
Place and manage spot orders, query execution history, and control kill-switch timers.
Collateral Trading
Manage collateral positions, leverage, hedge mode, and collateral order types (limit, market, OCO, OTO).
Convert
Estimate, confirm, and review currency conversion operations.
Account & Wallet
Main balance, deposits, withdrawals, transfers, codes, crypto lending, and fees.
Mining Pool
Monitor mining operations, manage payouts, track worker performance, and create watcher links.
Sub-Accounts
Create and manage sub-accounts, balances, transfers, and API keys.
OAuth
Third-party authorization: token exchange, refresh, 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
- Spot Trading — Place and manage orders
- WebSocket API — Real-time market data and account streams
- API Quick Start Helper — Multi-language SDK for authentication and requests