Help & API

Answers for miners. Data for builders.

Get a rig connected, understand what the numbers mean, or read HashBay data directly from the public JSON API.

Mining basics

Read the pool like an operator

The short version of the terms shown across HashBay.

01

Hashrate

An estimate of how much work a miner, pool, or network is performing each second. Short windows react quickly; longer averages are steadier.

02

Shares

Proof that your miner is doing valid work. Accepted shares count toward pool accounting; stale or rejected shares do not count the same way.

03

Round effort

Work spent relative to the statistically expected work for a block. Below 100% is an early find; above 100% is a longer round. It is not a countdown.

04

Block closeness

The strongest submitted share compared with the network target. At 100%, a share met the target and found a block; lower values were valid near-misses.

05

Pending vs. confirmed

A found block must mature on-chain. Rewards stay pending while immature and move to confirmed only after the required confirmations.

06

Worker names

Use WALLET.WORKER, such as YOUR_WALLET.rig01. The suffix lets you tell rigs apart without creating pool accounts.

PPLNS

Rewards recent loyal work

Payments are based on valid shares inside the pool's rolling share window when a block is found. Consistent uptime provides steadier window coverage; earnings still vary with pool luck.

PROP

Splits a completed round

A block reward is divided in proportion to the valid shares miners contributed during that round, subject to the pool's published rules and fee.

SOLO

The finder receives the reward

Your miner works through pool infrastructure, but a payout depends on your own work finding a network-valid block. Variance is much higher than shared schemes.

Connection checks

Miner not showing up?

Check these in order. A worker appears only after HashBay receives a valid share in the displayed time window.

  1. Match the pool and algorithm

    Confirm your hardware supports the selected coin's algorithm and that you copied the URL from that exact pool.

  2. Verify URL, username, and password

    Use the full Stratum URL, your receiving address as the username, an optional .worker suffix, and the generated password value.

  3. Look for accepted shares

    “Connected” alone is not enough. Check the miner log for accepted shares and correct clock or network errors before using Wallet Lookup.

  4. Check service and wallet views

    If shares are accepted but missing after the active window updates, check service status, then search the exact wallet address used by the miner.

JSON API

Public endpoint reference

All paths below use the production base URL. Responses are JSON, times are UTC unless noted, and rate-limited requests return HTTP 429.

Base URL https://api.hashbay.io
poolIdConfigured pool identifier
windowSecStatistics time window
bucketSecSeries bucket size
limitMaximum list rows

Pool operations

Configuration, live activity, network context, blocks, payout records, and available proof.

MethodPathReturns
GET/poolsConfigured pools, algorithms, schemes, fees, payout minimums, maturity, heights, and ports.
GET/summaryOne authoritative NA + EU pool total, regional accepted-share breakdown, and distinct active miner/worker counts.
GET/summariesCombined regional statistics for comma-separated poolIds.
GET/top-minersTop miners by estimated hashrate in the requested window.
GET/hashrate-seriesBucketed pool hashrate series for charts.
GET/networkAvailable network difficulty, peers, and network hashrate for a pool.
GET/blocks/recentRecent blocks with status, reward, effort, and maturity progress.
GET/blocks/summaryBlock counts and averages over a requested window.
GET/payouts/recentRecent payout records grouped by transaction ID, with published proof links when available.
GET/pricesUSD lookup for comma-separated ticker symbols.

Wallet, referral, and diagnostics

Read-only wallet routes do not require an unlock token.

MethodPathReturns
GET/wallet/existsWhether an address exists in a specific pool or any pool.
GET/wallet/public/summaryPublic total, confirmed, and pending wallet balances.
GET/wallet/public/statsPublic wallet shares and hashrate windows.
GET/wallet/public/seriesBucketed public wallet activity series.
GET/referrals/programReferral fee-reduction rules for a pool.
GET/referrals/summaryReferral code, attribution, and counts for a wallet.
GET/referrals/ledgerReferral activity ledger for a wallet.
GET/referrals/code/:codePool and referrer label associated with a referral code.
GET/pplns/diagnosticsPPLNS simulator, variance, and payout-change diagnostics.

Platform and launch

MethodPathPurpose
GET/healthAPI health check.
GET/client-ipCaller public IPv4 when available.
GET/statusPlatform status plus independent NA/EU Stratum port health, latency, uptime, and recent checks.
GET/launch/programLaunch workflow and package metadata.
GET/launch/experimentalPublished experimental launch-lane feed.
GET/launch/applications/:publicTokenPublic application tracking.
Request examples

Start with a configured pool ID

Fetch /pools first rather than hard-coding the current lineup.

List configured pools
curl -s https://api.hashbay.io/pools
Read a one-hour pool summary
curl -s "https://api.hashbay.io/summary?poolId=bitcoin2&windowSec=3600"
Read recent block proof
curl -s "https://api.hashbay.io/blocks/recent?poolId=bitcoin2&limit=10"