Pool Documentation & API Reference
Use this page as a pool information guide first, with public API references included as a secondary integration aid.
Pool Usage Notes
This page primarily documents the public pool experience: how miners discover a pool, connect, review performance, and verify blocks, payments, and donation activity.
Pool overview
Each pool page summarizes current hashrate, connected miners, shares per second, round effort, and network state so operators can quickly assess health.
Connection guidance
The connect page is the best place to confirm the public stratum host, port, and algorithm before pointing miners at a pool.
Miner dashboards
Once a miner has submitted shares, the miner dashboard exposes balances, workers, payments, and donation activity tied to that address.
Payments and blocks
Historical payments and discovered blocks are intentionally visible in the UI so miners can verify pool activity without needing privileged access.
Donations
Donation stats and transfer history provide transparent reporting for paid donations while avoiding sensitive operational configuration details.
Read-only docs scope
This documentation only covers public, non-sensitive endpoints and workflows that are safe to share with miners, operators, and integrators.
Helpful UI Routes
/{poolId}— pool overview with hashrate, effort, workers, and network context./{poolId}/connect— connection details and miner configuration guidance./{poolId}/stats— pool vs network performance charts and aggregate statistics./{poolId}/paymentsand/{poolId}/blocks— historical payout and block activity.
Miner Workflow
- Choose a pool and confirm the algorithm, host, and port from the connect view.
- Start mining with your wallet address, then use the miner dashboard once shares are submitted.
- Review workers, unpaid balance changes, payments, and donation activity from the dashboard.
API Reference
The public API mirrors the same operational data used throughout the UI, making it useful for monitoring, reporting, and lightweight automation after you understand the pool flows above.
- Responses are best used for dashboards, pool overviews, payment history, and miner-level status checks.
- Collection endpoints commonly accept paging parameters such as page and pageSize so large result sets stay lightweight.
- Donation reporting endpoints expose paid totals and transfer history from the ledger-backed migration forward.
- Read-only examples below are safe references for integrations, scripts, and internal tooling.
- Start with
/poolsto discover pool IDs that already exist. - Use a specific pool endpoint for live stats, payments, blocks, or donations.
- Switch to miner endpoints when you need address-specific balances, workers, or payout history.
Reference Endpoints
Open API base| Endpoint | Description | Example |
|---|---|---|
| Pools | List available pools and the core metadata needed to drive navigation or monitoring. | /pools |
| Pool Stats | Fetch a single pool snapshot including hashrate, miners, network stats, and current round info. | /pools/{poolId} |
| Pool Blocks | Review recent pool blocks with paging for block explorer views or reporting jobs. | /pools/{poolId}/blocks?page=0&pageSize=50 |
| Pool Payments | Load recent pool payments in manageable batches for payout history or exports. | /pools/{poolId}/payments?page=0&pageSize=50 |
| Pool Performance (v2) | Fetch paged pool performance with newest-page selection while each page stays chronologically ascending for chart rendering. | /v2/pools/{poolId}/performance?page=0&pageSize=250&r=Day&i=Hour |
| Miner Dashboard | Get miner-specific balances, worker activity, performance, and payment context. | /pools/{poolId}/miners/{address} |
| Miner Active Donations | Inspect current donation configuration and related miner donation state. | /pools/{poolId}/miners/{address}/donations |
| Miner Donation Stats | Summarize total paid donations for a miner after ledger-backed tracking began. | /pools/{poolId}/miners/{address}/donations/paid/stats |
| Miner Workers (v2) | Inspect worker-level last-share activity and inactive status using the paged v2 worker endpoint. | /v2/pools/{poolId}/miners/{address}/workers?page=0&pageSize=250&lookbackDays=30&inactiveThresholdMinutes=15 |
| Miner Donation History (v2) | Page through individual donation transfers for a miner using the v2 history endpoint. | /v2/pools/{poolId}/miners/{address}/donations/paid?page=0&pageSize=15 |
| Pool Donation Stats | Read pool-level aggregate donation totals for reporting or transparency views. | /pools/{poolId}/donations/paid/stats |
| Pool Donation History (v2) | Review pool donation transfer history with page controls for larger ledgers. | /v2/pools/{poolId}/donations/paid?page=0&pageSize=15 |