General Info
https://poolwatch.info/api/pools/
Get a list of all pools and their information.
https://poolwatch.info/api/pools/:poolName
Get information about a single pool.
Parameters:
- poolName - The pool name shown on poolwatch
https://poolwatch.info/api/pools/:poolName/history/:start/:end
Get information about a single pool.
Parameters:
- poolName - The pool name shown on poolwatch
- start - A valid javascript date
- end - A valid javascript date
Get Pool List
https://poolwatch.info/api/pools
Get a list of all pools and their information.
Sample response:
[
  {
    "pool": "BeepPool",
    "name": "BeepPool",
    "js_key": "beeppool",
    "displayName": "BeepPool",
    "hashRate": 137942513,
    "devices": 1935,
    "userCount": 188,
    "color": "#acc236",
    "tagLine": "Beep beep!",
    "websiteUrl": "https://beeppool.org/",
    "websiteDisplay": "beeppool.org",
    "teamSize": 1,
    "logo": "beep.svg",
    "poolFee": 1,
    "registrations": 1,
    "registrationsOpen": 0,
    "lastUpdate": "2018-07-22T11:02:30.000Z",
    "percent_of_network": 19.887
  },
  {
    "pool": "SushiPool",
    "name": "SushiPool",
    "js_key": "sushipool",
    "displayName": "SushiPool",
    "hashRate": 10553239,
    "devices": 543,
    "userCount": 286,
    "color": "#9a67ab",
    "tagLine": "Mine with us and eat sushi!",
    "websiteUrl": "https://sushipool.com",
    "websiteDisplay": "sushipool.com",
    "teamSize": 4,
    "logo": "sushipool.png",
    "poolFee": 1,
    "registrations": 0,
    "registrationsOpen": 0,
    "lastUpdate": "2018-07-22T11:03:37.000Z",
    "percent_of_network": 1.521
  },
  {
    "pool": "NimiqChain",
    "name": "NimiqChain",
    "js_key": "nimiqchain",
    "displayName": "NimiqChain",
    "hashRate": 9628326,
    "devices": 337,
    "userCount": 37,
    "color": "#F28F00",
    "tagLine": "Clean, simple and smooth Nimiq pool",
    "websiteUrl": "https://pool.nimiqchain.info",
    "websiteDisplay": "pool.nimiqchain.info",
    "teamSize": 2,
    "logo": "nimiq_chain.svg",
    "poolFee": 1,
    "registrations": 0,
    "registrationsOpen": 0,
    "lastUpdate": "2018-07-22T11:03:56.000Z",
    "percent_of_network": 1.388
  },
  ...
]
                                
Get Pool Info
https://poolwatch.info/api/pools/:poolName
Get information about a single pool.
Parameters:
Parameter name Required Info
:poolName Yes The pool name shown on poolwatch
Sample response:
{
  "pool": "SushiPool",
  "displayName": "SushiPool",
  "hashRate": 35059240,
  "devices": 8468,
  "userCount": 386,
  "color": "#9a67ab",
  "tagLine": "Mine with us and eat sushi!",
  "websiteUrl": "https://sushipool.com",
  "websiteDisplay": "sushipool.com",
  "teamSize": 4,
  "logo": "sushipool.png",
  "poolFee": 1,
  "payoutInterval": 10800,
  "payoutMinimum": 100000,
  "registrations": 0,
  "registrationsOpen": 0,
  "walletAddress": "NQ32 473Y R5T3 979R 325K S8UT 7E3A NRNS VBX2",
  "dynamicPoolInfo": 1,
  "dayAgo": {
    "hashRate": {
      "percent_change": -13.744728559404876,
      "number_change": -5586670,
      "value": 40645910
    },
    "devices": {
      "percent_change": -2.217090069284069,
      "number_change": -192,
      "value": 8660
    },
    "userCount": {
      "percent_change": 9.3484419263456,
      "number_change": 33,
      "value": 353
    }
  },
  "lastUpdate": 1533580751000
}
                                
Get Pool History
https://poolwatch.info/api/pools/:poolName/history/:startDate/:endDate
Get the history from a pool. Including user count and device count.
Limited to 200 rows. Parameters:
Parameter name Required Info
:poolName Yes The pool name shown on poolwatch
:startDate Yes Start date. This must be a valid javascript date.
:poolName Yes End date. This must be a valid javascript date.
Sample response:
{
  "history": [
    {
      "hashRate": 62975866,
      "userCount": 297,
"devices": 798,
      "timestamp": "2018-07-20T00:02:31.000Z",
      "workerName": "PoolWatch.info EU 1"
    },
    {
      "hashRate": 64116508,
      "devices": 798,
      "userCount": 294,
      "timestamp": "2018-07-20T01:02:30.000Z",
      "workerName": "PoolWatch.info EU 2"
    },
    {
      "hashRate": 63777570,
      "userCount": 289,
      "devices": 798,
      "timestamp": "2018-07-20T02:02:36.000Z",
      "workerName": "PoolWatch.info EU 1"
    },
    {
      "hashRate": 62779188,
      "userCount": 289,
      "devices": 798,
      "timestamp": "2018-07-20T03:02:33.000Z",
      "workerName": "PoolWatch.info EU 2"
    },
    {
      "hashRate": 63207163,
      "userCount": 291,
      "devices": 798,
      "timestamp": "2018-07-20T04:02:31.000Z",
      "workerName": "PoolWatch.info EU 2"
    },
    {
      "hashRate": 65276387,
      "userCount": 298,
      "devices": 798,
      "timestamp": "2018-07-20T05:02:30.000Z",
      "workerName": "PoolWatch.info EU 1"
    }
  ]
}
                                
Dynamic Pool Info (poolinfo.json)
-
PoolWatch allows pool owners to update their info dynamically.
This is done by requesting poolinfo.json, from their domains. Below a list of urls which are checked.
Pool name Expected url Implemented
BeepPool https://beeppool.org/poolinfo.json Yes
SushiPool https://sushipool.com/poolinfo.json Yes
SiriusPool https://siriuspool.net/poolinfo.json Yes
NimPool https://nimpool.io/poolinfo.json Yes
PhilPool https://philpool.com/poolinfo.json Yes
NimBus https://nimbus.fun/poolinfo.json Yes
NimiqWatch https://pool.nimiq.watch:8443/poolinfo.json Yes
NimiqPocket https://kr.nimiqpocket.com:5656/poolinfo.json Yes
Poolwatch expects the following json structure upon requesting.
{
  "teamSize": <int> // 4
  "tagLine": <string> // "Mine with us"
  "color": <hex color for graph> // Eg: #c9c9c9
  "poolFee": <float> // Pool fee in float
  "payoutInterval": <int> // Pool payout interval in seconds (3 hour = 10800)
  "payoutMinimum": <int> // Minimum pool balance in satoshis to get payed out
  "registrations": <bool> // if you require registrations set to true
  "registrationsOpen": <bool> // false if registrations closed
  "walletAddress": <string> // Nimiq wallet address
}