Skip to main content
Create a mining account, retrieve stratum connection details, monitor hashrate, and configure payout destination — all via API.

​
Prerequisites

  • A WhiteBIT account with completed KYC (register)
  • An API key with appropriate permissions (create key)
  • HMAC-SHA512 signing configured (authentication guide)
  • curl and jq installed (for command-line examples)
Mining account creation is fully API-driven and requires no prior UI setup. However, actual mining requires connecting ASIC hardware (or a hosted mining service) to the stratum URL provided in Step 2. Without connected hardware, hashrate will be zero and no rewards will accrue.
1

Create a mining account

Create a new mining account with a unique name.
curl -X POST https://whitebit.com/api/v4/mining/accounts/create \
  -H "Content-Type: application/json" \
  -H "X-TXC-APIKEY: YOUR_API_KEY" \
  -H "X-TXC-PAYLOAD: YOUR_PAYLOAD" \
  -H "X-TXC-SIGNATURE: YOUR_SIGNATURE" \
  -d '{
    "name": "my_miner_01",
    "request": "/api/v4/mining/accounts/create",
    "nonce": "1709340000000"
  }'
For Go and PHP examples, see SDKs.Required field: name (unique, alphanumeric + underscores, max 255 characters). Optional: referralCode.Expected response:
{
  "data": {
    "name": "my_miner_01",
    "createdAt": 1709340000
  }
}
2

View stratum connection details

Retrieve stratum URLs, fee information, and worker counts for the mining account.
curl -X POST https://whitebit.com/api/v4/mining/miners/info \
  -H "Content-Type: application/json" \
  -H "X-TXC-APIKEY: YOUR_API_KEY" \
  -H "X-TXC-PAYLOAD: YOUR_PAYLOAD" \
  -H "X-TXC-SIGNATURE: YOUR_SIGNATURE" \
  -d '{
    "account": "my_miner_01",
    "request": "/api/v4/mining/miners/info",
    "nonce": "1709340000001"
  }'
Expected response:
{
  "data": {
    "fee": "2.5",
    "workers": {
      "online": 0,
      "offline": 0,
      "low": 0
    },
    "stratum": [
      {"url": "stratum+tcp://pool.whitebit.com:3333", "workersCount": 0},
      {"url": "stratum+tcp://pool.whitebit.com:3334", "workersCount": 0}
    ]
  }
}
Use the returned stratum URL and port to configure mining hardware. Set the user field in the miner configuration to the mining account name (my_miner_01).
3

Check hashrate

Monitor hashrate performance for the mining account.
curl -X POST https://whitebit.com/api/v4/mining/hashrate \
  -H "Content-Type: application/json" \
  -H "X-TXC-APIKEY: YOUR_API_KEY" \
  -H "X-TXC-PAYLOAD: YOUR_PAYLOAD" \
  -H "X-TXC-SIGNATURE: YOUR_SIGNATURE" \
  -d '{
    "account": "my_miner_01",
    "interval": "1h",
    "request": "/api/v4/mining/hashrate",
    "nonce": "1709340000002"
  }'
Expected response:
{
  "data": {
    "account": "my_miner_01",
    "hashrate": [
      {"timestamp": 1709340000, "hashrate": "0", "rejectRate": 0}
    ]
  }
}
Hashrate will be zero until mining hardware connects and submits shares. Available intervals: 5m, 1h, 24h.
4

Configure payout destination

Set the payout destination to Main balance (for trading or lending) or an external BTC address (for cold storage).
# Option A: Payout to Main balance
curl -X POST https://whitebit.com/api/v4/mining/payout-destination/edit \
  -H "Content-Type: application/json" \
  -H "X-TXC-APIKEY: YOUR_API_KEY" \
  -H "X-TXC-PAYLOAD: YOUR_PAYLOAD" \
  -H "X-TXC-SIGNATURE: YOUR_SIGNATURE" \
  -d '{
    "accountName": "my_miner_01",
    "destination": "main_balance",
    "request": "/api/v4/mining/payout-destination/edit",
    "nonce": "1709340000003"
  }'

# Option B: Payout to external BTC address
curl -X POST https://whitebit.com/api/v4/mining/payout-destination/edit \
  -H "Content-Type: application/json" \
  -H "X-TXC-APIKEY: YOUR_API_KEY" \
  -H "X-TXC-PAYLOAD: YOUR_PAYLOAD" \
  -H "X-TXC-SIGNATURE: YOUR_SIGNATURE" \
  -d '{
    "accountName": "my_miner_01",
    "destination": "external_address",
    "address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
    "request": "/api/v4/mining/payout-destination/edit",
    "nonce": "1709340000004"
  }'
Required fields: accountName, destination (main_balance or external_address). When destination is external_address, the address field (BTC address) is also required.Expected response:
{
  "payoutDestination": "main_balance",
  "externalAddress": null
}
After connecting mining hardware to the stratum URL from Step 2, hashrate data appears within minutes. Rewards begin accruing once shares are submitted. Track rewards via POST /api/v4/mining/rewards.

​
What’s Next

Mining Pool Overview

Capabilities, integration patterns, and technical details.

API Reference

Full endpoint documentation for all 11 mining endpoints.
For Go and PHP examples, see SDKs.