> ## Documentation Index > Fetch the complete documentation index at: https://docs.whitebit.com/llms.txt > Use this file to discover all available pages before exploring further. # Mining Pool Quickstart > Create a mining account, view stratum connection details, check hashrate, and configure payout destination -- step by step. export const RegionBaseUrl = ({className = "", showBaseUrl = true}) => { const [region, setRegionState] = useState(() => { if (typeof window !== 'undefined') { return localStorage.getItem("api-region-preference") || "com"; } return "com"; }); const [mounted, setMounted] = useState(false); const observerRef = useRef(null); const isSyncingRef = useRef(false); const updateAllContentOnPage = targetRegion => { try { const domainFrom = targetRegion === "eu" ? "whitebit.com" : "whitebit.eu"; const domainTo = targetRegion === "eu" ? "whitebit.eu" : "whitebit.com"; const links = document.querySelectorAll('a'); links.forEach(link => { let href = link.getAttribute('href'); if (href && href.includes(domainFrom)) { link.setAttribute('href', href.replace(domainFrom, domainTo)); } }); const walker = document.createTreeWalker(document.body, NodeFilter.SHOW_TEXT, { acceptNode: node => { if (node.parentElement?.closest('.region-toggle-component')) { return NodeFilter.FILTER_REJECT; } return node.textContent.includes(domainFrom) ? NodeFilter.FILTER_ACCEPT : NodeFilter.FILTER_REJECT; } }); let currentNode; while (currentNode = walker.nextNode()) { currentNode.textContent = currentNode.textContent.replace(new RegExp(domainFrom, 'g'), domainTo); } console.log(`[RegionSync] Global content updated to ${domainTo}`); } catch (e) { console.error("[RegionSync] Error updating content:", e); } }; const updateRegion = (newRegion, source) => { if (region === newRegion) return; console.log(`[RegionBaseUrl] Updating to "${newRegion}" (Source: ${source})`); if (source === 'observer') { isSyncingRef.current = true; setTimeout(() => isSyncingRef.current = false, 1000); } setRegionState(newRegion); localStorage.setItem("api-region-preference", newRegion); updateAllContentOnPage(newRegion); if (source === 'user-click') { window.dispatchEvent(new CustomEvent("regionChange", { detail: newRegion })); attemptToUpdateNativeDropdown(newRegion, 0); setTimeout(() => attemptToUpdateNativeDropdown(newRegion, 1), 500); setTimeout(() => attemptToUpdateNativeDropdown(newRegion, 2), 1500); } }; const attemptToUpdateNativeDropdown = (targetRegion, attempt) => { if (isSyncingRef.current) return; try { const targetUrl = targetRegion === "eu" ? "https://whitebit.eu" : "https://whitebit.com"; const targetDesc = targetRegion === "eu" ? "EU Server" : "Production Server"; const selects = document.querySelectorAll('select'); for (const select of selects) { if (select.innerHTML.includes('whitebit.com') || select.innerHTML.includes('whitebit.eu')) { select.value = targetUrl; select.dispatchEvent(new Event('change', { bubbles: true })); return; } } const buttons = Array.from(document.querySelectorAll('button, [role="combobox"]')); const serverSelector = buttons.find(btn => { if (btn.closest('a') || btn.closest('[class*="card"]') || btn.closest('nav')) { return false; } const txt = btn.textContent || ""; const isServerDropdown = (txt.includes('Production Server') || txt.includes('EU Server') || txt.includes('WhiteBIT Global Server') || txt.includes('WhiteBIT EU Server')) && !txt.includes('Run') && !txt.includes('Send') || btn.getAttribute('role') === 'combobox'; return isServerDropdown; }); if (serverSelector) { const currentText = serverSelector.textContent || ""; if (currentText.includes(targetDesc)) return; serverSelector.click(); setTimeout(() => { const options = document.querySelectorAll('[role="option"], li, button'); for (const opt of options) { const optText = opt.textContent || ""; if (optText.includes(targetDesc) || optText.includes(targetUrl)) { opt.click(); return; } } }, 100); } } catch (e) { console.error("[Sync] Error:", e); } }; useEffect(() => { setMounted(true); updateAllContentOnPage(region); const handleStorageChange = e => { if (e.key === "api-region-preference" && e.newValue) { updateRegion(e.newValue, 'storage'); } }; const handleRegionChange = e => { if (e.detail !== region) { updateRegion(e.detail, 'event'); } }; window.addEventListener("storage", handleStorageChange); window.addEventListener("regionChange", handleRegionChange); observerRef.current = new MutationObserver(mutations => { if (isSyncingRef.current) return; updateAllContentOnPage(region); for (const mutation of mutations) { if (mutation.type !== 'childList' && mutation.type !== 'characterData') continue; const target = mutation.target; const el = target.nodeType === Node.TEXT_NODE ? target.parentElement : target; if (el && (el.getAttribute('role') === 'option' || el.closest('[role="listbox"]'))) continue; const text = target.textContent || ""; if (text.includes('WhiteBIT EU Server') || text.includes('https://whitebit.eu') && text.includes('Server')) { if (el && el.tagName !== 'A' && !el.closest('.region-toggle-component')) { if (region !== 'eu') updateRegion('eu', 'observer'); } } else if (text.includes('WhiteBIT Global Server') || text.includes('https://whitebit.com') && text.includes('Server')) { if (el && el.tagName !== 'A' && !el.closest('.region-toggle-component')) { if (region !== 'com') updateRegion('com', 'observer'); } } } }); observerRef.current.observe(document.body, { childList: true, subtree: true, characterData: true }); if (typeof window !== 'undefined') { const current = localStorage.getItem("api-region-preference"); if (current) attemptToUpdateNativeDropdown(current, 'init'); } return () => { window.removeEventListener("storage", handleStorageChange); window.removeEventListener("regionChange", handleRegionChange); if (observerRef.current) observerRef.current.disconnect(); }; }, [region]); const apiBaseUrl = region === "eu" ? "https://whitebit.eu" : "https://whitebit.com"; if (!mounted) return null; return
Base URL (
) {showBaseUrl && <> : {apiBaseUrl} }
; }; Mining account creation is API-only — no UI flow exists. The four steps below cover account creation, stratum lookup, hashrate monitoring, and payout configuration, all under one API key with the appropriate Mining scope. ## Prerequisites * A WhiteBIT account with completed KYC ([register](https://whitebit.com/auth/register)) * An API key with appropriate permissions ([create key](https://whitebit.com/settings/api)) * HMAC-SHA512 signing configured ([authentication guide](/api-reference/authentication)) * `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. Create a new mining account with a unique name. ```bash theme={"theme":{"light":"github-light","dark":"github-dark"}} 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" }' ``` ```python theme={"theme":{"light":"github-light","dark":"github-dark"}} import requests, json, hmac, hashlib, base64, time API_KEY = "YOUR_API_KEY" API_SECRET = "YOUR_SECRET" BASE_URL = "https://whitebit.com" def make_request(endpoint, body): nonce = str(int(time.time() * 1000)) body["request"] = endpoint body["nonce"] = nonce data_json = json.dumps(body) payload = base64.b64encode(data_json.encode()) signature = hmac.new( API_SECRET.encode(), payload, hashlib.sha512 ).hexdigest() headers = { "Content-Type": "application/json", "X-TXC-APIKEY": API_KEY, "X-TXC-PAYLOAD": payload.decode(), "X-TXC-SIGNATURE": signature, } return requests.post(f"{BASE_URL}{endpoint}", headers=headers, data=data_json) # Create a mining account response = make_request("/api/v4/mining/accounts/create", { "name": "my_miner_01", }) print(json.dumps(response.json(), indent=2)) ``` For Go and PHP examples, see [SDKs](/sdks). **Required field:** `name` (unique, alphanumeric + underscores, max 255 characters). **Optional:** `referralCode`. **Expected response:** ```json theme={"theme":{"light":"github-light","dark":"github-dark"}} { "data": { "name": "my_miner_01", "createdAt": 1709340000 } } ``` Retrieve stratum URLs, fee information, and worker counts for the mining account. ```bash theme={"theme":{"light":"github-light","dark":"github-dark"}} 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" }' ``` ```python theme={"theme":{"light":"github-light","dark":"github-dark"}} # Get stratum connection details response = make_request("/api/v4/mining/miners/info", { "account": "my_miner_01", }) print(json.dumps(response.json(), indent=2)) ``` **Expected response:** ```json theme={"theme":{"light":"github-light","dark":"github-dark"}} { "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`). Monitor hashrate performance for the mining account. ```bash theme={"theme":{"light":"github-light","dark":"github-dark"}} 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" }' ``` ```python theme={"theme":{"light":"github-light","dark":"github-dark"}} # Check hashrate response = make_request("/api/v4/mining/hashrate", { "account": "my_miner_01", "interval": "1h", }) print(json.dumps(response.json(), indent=2)) ``` **Expected response:** ```json theme={"theme":{"light":"github-light","dark":"github-dark"}} { "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`. Set the payout destination to Main balance (for trading or lending) or an external BTC address (for cold storage). ```bash theme={"theme":{"light":"github-light","dark":"github-dark"}} # 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" }' ``` ```python theme={"theme":{"light":"github-light","dark":"github-dark"}} # Option A: Payout to Main balance response = make_request("/api/v4/mining/payout-destination/edit", { "accountName": "my_miner_01", "destination": "main_balance", }) print(response.json()) # Option B: Payout to external BTC address response = make_request("/api/v4/mining/payout-destination/edit", { "accountName": "my_miner_01", "destination": "external_address", "address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh", }) print(response.json()) ``` **Required fields:** `accountName`, `destination` (`main_balance` or `external_address`). When `destination` is `external_address`, the `address` field (BTC address) is also required. **Expected response:** ```json theme={"theme":{"light":"github-light","dark":"github-dark"}} { "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 Stratum ports 3333 and 3334, hashrate intervals (5m, 1h, 24h), watcher links for shared monitoring, and the WhitePool platform branding. Full endpoint documentation for all 11 mining endpoints. For Go and PHP examples, see [SDKs](/sdks).