Private HTTP API Authentication

Overview

This guide explains how to authenticate with WhiteBit’s private HTTP API endpoints, which require authentication for security purposes.

Getting Started

Setting Up API Keys

1. Navigate to WhiteBit API Settings
2. Select the appropriate configuration tab for your API keys

   Different API keys provide access to different API endpoints

3. Generate a new API key
4. Recommended Security Measures:
   • Enable IP restrictions (specify up to 5 trusted IPs)
   • Enable Endpoint access restrictions (select only necessary endpoints)

Authentication Requirements

All authenticated requests must:

1. Use the POST HTTP method
2. Include specific body data
3. Contain required headers

Body Data Format

Your request body must be a JSON object containing:

Example Request Body:

{
    "request": "/api/v4/trade-account/balance",
    "nonce": 1594297865,
    "nonceWindow": true,
    "ticker": "BTC"
}

About Nonce Values

• A good practice is to use the Unix timestamp in milliseconds
• Ensure each nonce is larger than previous requests
• When nonceWindow is enabled:
  • Provide Unix timestamp in milliseconds as the nonce
  • Timestamp must be within ±5 seconds of server time
  • Each nonce must be unique to prevent double processing
  • Useful for high-frequency trading systems with concurrent requests

Required Headers

Every authenticated request requires these headers:

The signature is created using: hex(HMAC_SHA512(payload, key=api_secret))

Implementation Examples

We provide the API Quick Start Helper library with examples in multiple languages:

• Python
• PHP
• NodeJS
• Go
• JavaScript
• Kotlin
• DotNet
• Ruby
• C++
• Rust

Common Errors