Getting started with the pool API
Read live pool and per-miner stats programmatically: the public JSON endpoints, how to query your own address, and fair-use notes.
What the API is for
Everything the dashboard shows is served by a public read-only JSON API, so you can build your own monitoring, a home dashboard, a bot or a spreadsheet that tracks your mining. It exposes pool-wide stats (hashrate, network difficulty, blocks, payments) and per-miner stats for any address, with no key and no account.
Pool-wide stats
The pool stats endpoint returns the same figures you see in the header and on the dashboard: pool and network hashrate, connected miners, difficulty, the last blocks and recent payments. Fetch it like any JSON URL:
curl https://pearl.herominers.com/api/statsYour own miner stats
To read a single address, pass it to the miner stats endpoint. The response includes that address's hashrate, workers, balances and recent payments, the raw data behind your dashboard page:
curl https://pearl.herominers.com/api/stats_address?address=YOUR_PRL_ADDRESSFair use
The API is there to be used, but poll it politely: the underlying numbers only update every so often, so requesting once every minute or two is plenty, and hammering it far more often just wastes both sides' bandwidth without giving you fresher data. Cache what you fetch, and build around the same update cadence the dashboard uses.