Skip to content

API

Jump to bottom
Steve. S edited this page Sep 7, 2025 · 1 revision

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.

API Endpoints

/api/pools

Returns configuration data and current stats for all configured pools.

Example Response:

{
  "pools": [
    {
      "id": "yerbassolo",
      "coin": {
        "type": "YERB",
        "name": "Yerbas",
        "symbol": "YERB",
        "website": "https://yerbas.org/",
        "market": "https://trade.nestex.one/spot/YERB_USDT",
        "family": "bitcoin",
        "algorithm": "Ghostrider",
        "twitter": "https://twitter.com/Yerbas_Endeavor",
        "discord": "https://discord.com/invite/XGEp2cKSKF",
        "discordColor": "3066993",
        "github": "https://github.com/The-Yerbas-Endeavor/yerbas",
        "miningPoolStats": "https://miningpoolstats.stream/ico/yerbas.png",
        "telegram": "",
        "canonicalName": "Yerbas"
      },
      "ports": {
        "5009": {
          "listenAddress": "0.0.0.0",
          "name": "CPU",
          "difficulty": 0.1,
          "varDiff": {
            "minDiff": 0.1,
            "targetTime": 15,
            "retargetTime": 90,
            "variancePercent": 25
          },
          "tls": false,
          "tlsAuto": false
        }
      },
      "paymentProcessing": {
        "enabled": true,
        "minimumPayment": 67.5,
        "payoutScheme": "SOLO",
        "payoutSchemeConfig": [
          [
            []
          ]
        ],
        "extra": {}
      },
      "clientConnectionTimeout": 600,
      "jobRebroadcastTimeout": 10,
      "blockRefreshInterval": 60,
      "poolFeePercent": 0,
      "address": "yiUDppRzHsyR7rBKkfwVvD39SYiZPM7CEt",
      "addressInfoLink": "https://explorer.yerbas.org/address/yiUDppRzHsyR7rBKkfwVvD39SYiZPM7CEt",
      "poolStats": {
        "connectedMiners": 1,
        "poolHashrate": 7709,
        "sharesPerSecond": 0
      },
      "networkStats": {
        "networkType": "Main",
        "networkHashrate": 126931.5985649826,
        "networkDifficulty": 0.004747173789,
        "nextNetworkTarget": "000000d2a6000000000000000000000000000000000000000000000000000000",
        "nextNetworkBits": "1e00d2a6",
        "lastNetworkBlockTime": "2025-09-07T03:01:15.8796813Z",
        "blockHeight": 856360,
        "connectedPeers": 56,
        "nodeVersion": "3010420",
        "rewardType": "POW"
      },
      "topMiners": [
        {
          "miner": "yMTEEBA6giHHEGEu4kq2QFnpMwQCxZcHRJ",
          "hashrate": 15675,
          "sharesPerSecond": 0.507
        }
      ],
      "totalPaid": 4200.000541280000,
      "totalBlocks": 61,
      "totalConfirmedBlocks": 56,
      "totalPendingBlocks": 5,
      "blockReward": 75.000000000000,
      "lastPoolBlockTime": "2025-09-07T02:38:09.521342Z",
      "poolEffort": 38778.99249411764
    }
  ]
}

/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/yerbassolo/blocks?page=0&pageSize=5
[
  {
    "poolId": "yerbassolo",
    "blockHeight": 856351,
    "networkDifficulty": 0.002946276744,
    "status": "pending",
    "confirmationProgress": 0.08823529411764706,
    "effort": 0.8653491723695438,
    "minerEffort": 0.8653491723695438,
    "transactionConfirmationData": "4acf3d30316b2f6af01939fceed1e2bef3ea38308d566183481246cdaea571f3",
    "reward": 0.000000000000,
    "infoLink": "https://explorer.yerbas.org/block/856351",
    "hash": "10ea21ba153544b91d5a3be0bf9611b77e853b70b57060b70f44088a6f5270fc",
    "miner": "yMTEEBA6giHHEGEu4kq2QFnpMwQCxZcHRJ",
    "source": "master",
    "created": "2025-09-07T02:38:09.521342Z"
  },
  {
    "poolId": "yerbassolo",
    "blockHeight": 856304,
    "networkDifficulty": 0.002918298853,
    "status": "pending",
    "confirmationProgress": 0.5490196078431373,
    "effort": 1.5168554770642626,
    "minerEffort": 1.5168554770642626,
    "transactionConfirmationData": "ffe53f03a78d2c748b63fcd26b56031e50917705cd0e419970cc149ed5e76d20",
    "reward": 0.000000000000,
    "infoLink": "https://explorer.yerbas.org/block/856304",
    "hash": "5c82953ab6ba730582c6a0bd041d5ac0683fb2a2c6b49d2b132a1a796864ff59",
    "miner": "yMTEEBA6giHHEGEu4kq2QFnpMwQCxZcHRJ",
    "source": "master",
    "created": "2025-09-07T01:49:28.97926Z"
  },
  {
    "poolId": "yerbassolo",
    "blockHeight": 856292,
    "networkDifficulty": 0.004525857782,
    "status": "pending",
    "confirmationProgress": 0.6666666666666666,
    "effort": 0.6718553063232456,
    "minerEffort": 0.6718553063232456,
    "transactionConfirmationData": "8201306c351b3cca79d289c746993229bd0cd081ed5b95f7a128db04be7e1022",
    "reward": 0.000000000000,
    "infoLink": "https://explorer.yerbas.org/block/856292",
    "hash": "8950593090538c93292ce2533512e7e7b1d8282bb914f1ffe0bbf23c68c72373",
    "miner": "yMTEEBA6giHHEGEu4kq2QFnpMwQCxZcHRJ",
    "source": "master",
    "created": "2025-09-07T00:36:58.198129Z"
  },
  {
    "poolId": "yerbassolo",
    "blockHeight": 856277,
    "networkDifficulty": 0.003471180541,
    "status": "pending",
    "confirmationProgress": 0.8137254901960784,
    "effort": 0.05765844174276111,
    "minerEffort": 0.05765844174276111,
    "transactionConfirmationData": "f0ffae7dc348feffc7b1906263ebe4c885ff8edaa92591652860be0214aeaaa0",
    "reward": 0.000000000000,
    "infoLink": "https://explorer.yerbas.org/block/856277",
    "hash": "d96300075931f1d3c65cbc27ecd0965049121710ca90279179e76de51b22d3b2",
    "miner": "yMTEEBA6giHHEGEu4kq2QFnpMwQCxZcHRJ",
    "source": "master",
    "created": "2025-09-07T00:14:39.487223Z"
  },
  {
    "poolId": "yerbassolo",
    "blockHeight": 856263,
    "networkDifficulty": 0.003709604453,
    "status": "pending",
    "confirmationProgress": 0.9509803921568627,
    "effort": 0.4738035871455688,
    "minerEffort": 0.4738035871455688,
    "transactionConfirmationData": "0e52b436d651aacb047e6734c1f134f3a92cecd6497c62b7361482ebc0dd06d2",
    "reward": 0.000000000000,
    "infoLink": "https://explorer.yerbas.org/block/856263",
    "hash": "4238c836d1750ad9faf88b8b4522fdafd13fe068b7cdec7a4edfe66e52078e7c",
    "miner": "yMTEEBA6giHHEGEu4kq2QFnpMwQCxZcHRJ",
    "source": "master",
    "created": "2025-09-07T00:00:59.469676Z"
  }
]

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

Returns pool performance stats for the last 24 hours.

Example Response:

{
  "stats": [
    {
      "poolHashrate": 7603.6113,
      "connectedMiners": 1,
      "validSharesPerSecond": 0,
      "networkHashrate": 71935.77759017002,
      "networkDifficulty": 0.002424915714111111,
      "created": "2025-09-06T03:00:00Z"
    },
    {
      "poolHashrate": 7089.1665,
      "connectedMiners": 1,
      "validSharesPerSecond": 0,
      "networkHashrate": 69313.38576397471,
      "networkDifficulty": 0.0020858771529999997,
      "created": "2025-09-06T04:00:00Z"
    },
    {
      "poolHashrate": 5254,
      "connectedMiners": 1,
      "validSharesPerSecond": 0,
      "networkHashrate": 68059.73526178324,
      "networkDifficulty": 0.0019497414208333335,
      "created": "2025-09-06T05:00:00Z"
    }
  ]
}

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

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

[
  {
    "miner": "yMTEEBA6giHHEGEu4kq2QFnpMwQCxZcHRJ",
    "hashrate": 15675,
    "sharesPerSecond": 0.507
  }
]

/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.

Example Response:

[
  {
    "coin": "YERB",
    "address": "yMTEEBA6giHHEGEu4kq2QFnpMwQCxZcHRJ",
    "addressInfoLink": "https://explorer.yerbas.org/address/yMTEEBA6giHHEGEu4kq2QFnpMwQCxZcHRJ",
    "amount": 75.000000000000,
    "transactionConfirmationData": "7a693adbc915a79f2f4bc9678bc461e3ce4ffb1573ba8cde84254efd321f217e",
    "transactionInfoLink": "https://explorer.yerbas.org/tx/7a693adbc915a79f2f4bc9678bc461e3ce4ffb1573ba8cde84254efd321f217e",
    "created": "2025-09-07T02:12:28.202396Z"
  },
  {
    "coin": "YERB",
    "address": "yMTEEBA6giHHEGEu4kq2QFnpMwQCxZcHRJ",
    "addressInfoLink": "https://explorer.yerbas.org/address/yMTEEBA6giHHEGEu4kq2QFnpMwQCxZcHRJ",
    "amount": 75.000012980000,
    "transactionConfirmationData": "ff2f9b72db287de5eafa456ee4807a60b8a6b098b8e512dcfeb64086f8cb7775",
    "transactionInfoLink": "https://explorer.yerbas.org/tx/ff2f9b72db287de5eafa456ee4807a60b8a6b098b8e512dcfeb64086f8cb7775",
    "created": "2025-09-07T02:02:27.975997Z"
  }
]

/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:

{
  "pendingShares": 568.0328777848943,
  "pendingBalance": 0.000000000000,
  "totalPaid": 4200.000541280000,
  "todayPaid": 1125.000086870000,
  "minerEffort": 1.303546556897434,
  "lastPayment": "2025-09-07T02:12:28.202396Z",
  "lastPaymentLink": "https://explorer.yerbas.org/tx/7a693adbc915a79f2f4bc9678bc461e3ce4ffb1573ba8cde84254efd321f217e",
  "performance": {
    "created": "2025-09-07T03:29:38.069971Z",
    "workers": {
      "Test_Bench_GPU": {
        "hashrate": 3246,
        "sharesPerSecond": 0.063
      },
      "GPT": {
        "hashrate": 771,
        "sharesPerSecond": 0.07
      },
      "SS": {
        "hashrate": 747,
        "sharesPerSecond": 0.063
      },
      "GPT_CPU": {
        "hashrate": 858,
        "sharesPerSecond": 0.073
      },
      "SS_CPU": {
        "hashrate": 782,
        "sharesPerSecond": 0.067
      }
    }
  },
  "performanceSamples": [
    {
      "created": "2025-09-06T03:00:00Z",
      "workers": {
        "GPT": {
          "hashrate": 1116.2333333333333,
          "sharesPerSecond": 0.0708
        },
        "GPT_CPU": {
          "hashrate": 1535.2333333333333,
          "sharesPerSecond": 0.07786666666666665
        },
        "SS": {
          "hashrate": 917.9333333333333,
          "sharesPerSecond": 0.06663333333333335
        },
        "SS_CPU": {
          "hashrate": 1202.6666666666667,
          "sharesPerSecond": 0.06446666666666666
        },
        "Test_Bench_GPU": {
          "hashrate": 4535.8,
          "sharesPerSecond": 0.07456666666666668
        }
      }
    }
  ],
  "totalConfirmedBlocks": 56,
  "totalPendingBlocks": 5
}

/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.

Example Response:

[
  {
    "coin": "YERB",
    "address": "yMTEEBA6giHHEGEu4kq2QFnpMwQCxZcHRJ",
    "addressInfoLink": "https://explorer.yerbas.org/address/yMTEEBA6giHHEGEu4kq2QFnpMwQCxZcHRJ",
    "amount": 75.000000000000,
    "transactionConfirmationData": "7a693adbc915a79f2f4bc9678bc461e3ce4ffb1573ba8cde84254efd321f217e",
    "transactionInfoLink": "https://explorer.yerbas.org/tx/7a693adbc915a79f2f4bc9678bc461e3ce4ffb1573ba8cde84254efd321f217e",
    "created": "2025-09-07T02:12:28.202396Z"
  },
  {
    "coin": "YERB",
    "address": "yMTEEBA6giHHEGEu4kq2QFnpMwQCxZcHRJ",
    "addressInfoLink": "https://explorer.yerbas.org/address/yMTEEBA6giHHEGEu4kq2QFnpMwQCxZcHRJ",
    "amount": 75.000012980000,
    "transactionConfirmationData": "ff2f9b72db287de5eafa456ee4807a60b8a6b098b8e512dcfeb64086f8cb7775",
    "transactionInfoLink": "https://explorer.yerbas.org/tx/ff2f9b72db287de5eafa456ee4807a60b8a6b098b8e512dcfeb64086f8cb7775",
    "created": "2025-09-07T02:02:27.975997Z"
  }
]

/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.

Example Response:

[
  {
    "created": "2025-09-06T03:00:00Z",
    "workers": {
      "GPT": {
        "hashrate": 1116.2333333333333,
        "sharesPerSecond": 0.0708
      },
      "GPT_CPU": {
        "hashrate": 1535.2333333333333,
        "sharesPerSecond": 0.07786666666666665
      },
      "SS": {
        "hashrate": 917.9333333333333,
        "sharesPerSecond": 0.06663333333333335
      },
      "SS_CPU": {
        "hashrate": 1202.6666666666667,
        "sharesPerSecond": 0.06446666666666666
      },
      "Test_Bench_GPU": {
        "hashrate": 4535.8,
        "sharesPerSecond": 0.07456666666666668
      }
    }
  }
]

Clone this wiki locally