Mining hardware API documentation

This section describes the authenticated Hardware API. Include your API key with every request (using the X-API-Key header or ?key= while testing). Requests made without a valid key are rejected with HTTP 401.

https://api.minerstat.com/v2/hardware

Headers

Header
Value
Description
X-API-Key
string
Required. API key issued in the Developer Portal. Keys are tied to your subscription quota.

Parameters

Parameter
Type
Description
type
string
Filter by hardware category, e.g. ?type=gpu or ?type=asic.
brand
string
Filter by manufacturer or marketplace, e.g. ?brand=antminer.
key
string
Optional query alternative to the header for quick tests (not recommended for production calls).

Example calls

curl \"https://api.minerstat.com/v2/hardware\" -H \"X-API-Key: YOUR_KEY\"
curl \"https://api.minerstat.com/v2/hardware?type=gpu\" -H \"X-API-Key: YOUR_KEY\"
curl \"https://api.minerstat.com/v2/hardware?brand=antminer\" -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
22
23
24
25
26
27
28
29
30
31
[
 {
  "id": "a195fd59ce0ebc3f9b2d99b3c396ff198bcb4a5e",
  "name": "Nvidia RTX 3080",
  "url": "nvidia-rtx-3080",
  "type": "gpu",
  "brand": "nvidia",
  "algorithms": {,
   "ethash": {,
    "hashrate": 97200000,
    "power": 240,
   },
   "kawpow": {,
    "hashrate": 46450000,
    "power": 279,
   }, ...
  },
  "specs": {,
   "Release": "September 2020",
   "Base Clock": "1440 MHz",
   "Boost Clock": "1710 MHz",
   "Memory Clock": "9500 MHz",
   "GPU Power": "320 W",
   "Max temp.": "93°C",
   "CUDA cores": "8704",
   "Memory Interface": "320 Bits",
   "Max Memory Size": "10 GB",
   "Memory Type": "GDDR6X"
  }
 }, ...
]
Parameter
Type
Description
id
string
Unique identifier of the hardware.
name
string
Hardware name.
url
string
Hardware unique URL.
type
string
Hardware's type, for example asic and gpu
brand
string
Hardware's brand, for example nvidia,amd, antminer, whatsminer, etc.
algorithms
object{}
List of benchmarked algorithms and hardware's estimated hashrate [H/s] and power consumption [W] for each algorithm.
algorithms.{ALGORITHM}.hashrate
number
Estimated hashrate for mining {ALGORITHM} in H/s.
algorithms.{ALGORITHM}.power
number
Estimated power consumption for mining {ALGORITHM} in W.
specs
object{}
List of different hardware specifications.

Quota — each successful call counts toward your monthly request allowance. When the allowance is exhausted you will receive HTTP 402 responses until the next billing period or an upgrade.