API Documentation

Public Pool API

Public read-only JSON endpoints for pool stats, leaderboard, blocks, payouts and readiness.

Public, read-only JSON

All public endpoints use HTTPS, require no API key and expose no full wallet addresses in pool-wide lists.

PublicNo authJSONRead-only
https://pearlpool.cloud/api/v1/stats
GET

Canonical snapshot

/api/v1/stats

Stable pool, share, block, miner and payout summary.

Open endpoint →
GET

Pool stats

/api/pool/stats

Compatibility response with raw H/s values and readable text fields.

Open endpoint →
GET

Leaderboard

/api/leaderboard

Masked wallets, workers, PPLNS contribution and live hashrate.

Open endpoint →
GET

Wallet lookup

/api/wallet?wallet=YOUR_PRL_WALLET

Workers, shares, hashrate, payout status and proof submissions for one wallet.

Open endpoint →
GET

Submission flow

/api/submissions

Cumulative forwarded-proof counters and gateway submission status.

Open endpoint →
GET

Pool blocks

/api/blocks

Confirmed pool block history, reward and maturity information.

Open endpoint →
GET

Payout state

/api/payouts

Public payout rounds, gate state, ledger and batch status.

Open endpoint →
GET

Health

/api/health

Returns 200 while the public stats snapshot is current.

Open endpoint →
GET

Readiness

/api/readiness

Operational checks for shares, candidates, confirmed blocks and payouts.

Open endpoint →

Counter semantics

gateway.proofsForwardedCumulative pool counter for proofs sent to the gateway. It does not mean confirmed blocks.
candidateProofsAcceptedCandidate-level gateway/node result. Still separate from confirmed chain blocks.
blocks.confirmedConfirmed pool blocks detected from chain data. This is the source for payout rounds.
payout.gate.openTrue only when live payout is armed for real execution, the confirmation gate is present, and a mature payout round exists.