Mining pools API documentation
This page documents the authenticated Pools API. Attach your API key (header or query parameter while testing) to every request; otherwise the call is rejected with HTTP 401.
https://api.minerstat.com/v2/pools
Headers
Header
Value
Description
X-API-Keystring
Required. Your developer API key; counted against the subscription quota.
Parameters
Parameter
Type
Description
coinstring
Filter by payout coin symbol (e.g. ?coin=ETH).
typestring
Filter by pool category (e.g. ?type=multipool).
keystring
Optional query parameter version of the API key. Use only for testing.
Example calls
curl \"https://api.minerstat.com/v2/pools\" -H \"X-API-Key: YOUR_KEY\"
curl \"https://api.minerstat.com/v2/pools?coin=ETH\" -H \"X-API-Key: YOUR_KEY\"
curl \"https://api.minerstat.com/v2/pools?type=multipool\" -H \"X-API-Key: YOUR_KEY\"
Example response
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
[
{
"id": "a195fd59ce0ebc3f9b2d99b3c396ff198bcb4a5e",
"name": "Ezil",
"url": "ezil",
"description": "Ezil is a pool that will switch between Ethash coin (ETH or ETC) and ZIL to optimize the earnings. The fee is 1%.",
"website": "https://ezill.me",
"founded": 2019,
"type": "pool",
"coins": {
"ETH+ZIL": {
"algorithm": "Ethash",
"payoutThreshold": "0.01 ETH",
"rewardMethod": "PPS+",
"fee": "1%",
"anonymous": true,
"registration": false
}, ...
}
}, ...
]
Parameter
Type
Description
idstring
Unique identifier of the pool.
namestring
Pool's name.
urlstring
Pool's unique URL.
descriptionstring
Pool's description.
websitestring
Pool's website.
foundedstring
Year in which the pool was founded.
typestring
Pool's type, for example pool and multipool
coinsobject{}
List of coins supported by the pool.
coins.{COIN}.algorithmstring
{COIN}'s mining algorithm.
coins.{COIN}.payoutThresholdstring
Pool's payout threshold when mining {COIN}.
coins.{COIN}.rewardMethodstring
Coin's reward method for mining {COIN}.
coins.{COIN}.feestring
Pool's fee for mining {COIN}.
coins.{COIN}.anonymousboolean
true if pool supports anonymous mining of {COIN} and false if pool doesn't support anonymous mining of {COIN}.
coins.{COIN}.registrationboolean
true if pool supports mining of {COIN} through registration and false if pool doesn't support mining of {COIN} through registration.
Quota — Successful responses consume one request from your monthly allowance. When the allowance is exhausted the API returns HTTP 402 until the quota resets.