API

Miningcore exposes a simple REST API at http://localhost:4000. The primary purpose of the API is to power custom web-frontends for the pool.

List of endpoints

/api/pools

Returns configuration data and current stats for all configured pools.

Example Response:

/api/pools/<pool-id>/performance

Returns pool performance stats for the last 24 hours.

Example Response:

/api/pools/<pool-id>/miners

Returns a pool's top miners by hashrate for the last 24 hours.

/api/pools/<pool-id>/blocks

Returns information about blocks mined by the pool. Results can be paged by using the page and pageSize query parameters. Note: transactionConfirmationData is usually the blockchain transaction id.

http://localhost:4000/api/pools/xmr1/blocks?page=2&pageSize=3

Example Response:

/api/pools/<pool-id>/payments

Returns information about payments issued by the pool. Results can be paged by using the page and pageSize query parameters. Note: transactionConfirmationData is usually the blockchain transaction id.

http://localhost:4000/api/pools/xmr1/payments?page=2&pageSize=3

Example Response:

/api/pools/<pool-id>/miners/<miner-wallet-address>

Provides current stats about a miner on a specific pool.

performance.workers is a dictionary where key is a worker name or an empty string for the default worker, and value is an object containing performance metrics for that worker. To compute the combined performance for a miner you need to accumulate the values of all workers in the dictionary.

Example Response:

/api/pools/<pool-id>/miners/<miner-wallet-address>/payments

Returns information about payments issued by the pool to specified miner. Results can be paged by using the page and pageSize query parameters. Note: transactionConfirmationData is usually the blockchain transaction id.

/api/pools/<pool-id>/miners/<miner-wallet-address>/performance

Returns miner performance stats for the last 24 hours. The information is broken down into a dictionary entry for each worker.