Workers

This is a detailed documentation on how you can check the list of all of your online and offline workers that are added to your minerstat dashboard. The result of this endpoint is object with multiple elements. Each element in the object is presented with worker name in uppercase letters. The data is refreshed every few seconds, which is shown in the sync parameter. All parameters available in the API are explained in details. Some parameters are available only for specific system and type combinations. If the worker is offline, most of the data is unavailable.

https://api.minerstat.com/v2/stats/{ACCESS_KEY}

Parameters

Parameter
Type
Description
Required{ACCESS_KEY}
string
This is your unique access key. If you forgot what is the value, check this help article.

Example call

https://api.minerstat.com/v2/stats/4cc355k3y

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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
{
 "WORKER001": {
  "info": {
   "type": "nvidia",
   "system": "linux",
   "status": "online",
   "inactive": 0,
   "status_reason": "",
   "status_cpu": "idle",
   "uptime": "3d 21h 7min",
   "sync": 4,
   "time": "2020-04-13 18:34:45",
   "note": 0,
   "profit_switch": 0,
   "name": "Worker001",
   "version": "4",
   "groups": "nvidia,msos",
   "cmd": "",
   "electricity": 0.05,
   "hot": 75,
   "veryHot": 85,
   "devices": 7,
   "consumption": "+150",
   "os": {
    "status": "online",
    "sync": 4,
    "uptime": "36d 10h 49min",
    "cpu_temp": 27,
    "cpu_load": 28,
    "freespace": 36.112,
    "freemem": 0.851,
    "localip": "192.168.0.3"
   }
  },
  "hardware": [
   {
    "name": "P102-100",
    "temp": 67,
    "fan": 99,
    "power": 169,
    "powerMin": 125,
    "powerMax": 300,
    "powerStock": 250,
    "speed": 42.508,
    "bus": "01:00.0",
    "core": 1657,
    "coreMax": 1911,
    "memory": 5643,
    "memoryMax": 5505,
    "load": 100
   },{
    "name": "P102-100",
    ...
   }, ...
  ],
  "revenue": {
   "usd_day": 3.663,
   "usd_day_dual": 0,
   "usd_day_cpu": 0,
   "usd_week": 25.643,
   "usd_month": 109.897,
   "usd_month_dual": 0,
   "usd_month_cpu": 0,
   "btc_day": 0.00054,
   "btc_week": 0.003779,
   "btc_month": 0.016197,
   "coin": 0.71335365,
   "coin_dual": 0,
   "coin_cpu": 0,
   "cprice": 5.13521,
   "cprice_dual": 0,
   "cprice_cpu": 0
  },
  "mining": {
   "client": "PHOENIX-ETH",
   "client_version": "4.9c",
   "client_cpu": "",
   "client_cpu_version": "",
   "crypto": "ETH",
   "crypto_dual": "",
   "crypto_cpu": "",
   "pool": "eth.2miners.com: 2020",
   "pool_dual": "",
   "pool_cpu": "",
   "hashrate": {
    "hashrate": 304.67,
    "hashrate_unit": "MH",
    "hashrate_dual": 0,
    "hashrate_unit_dual": "",
    "hashrate_cpu": 0,
    "hashrate_unit_cpu": ""
   },
   "shares": {
    "accepted_share": 11958,
    "accepted_share_dual": 0,
    "accepted_share_cpu": 0,
    "rejected_share": 0,
    "rejected_share_dual": 0,
    "rejected_share_cpu": 0
   }
  }
 },
 "WORKER002": {
  ...
 }, ...
}
Parameter
Type
Description
info
object{}
Information on different system characteristics of a worker.
 info.type
string
Type of your worker, for example nvidia, amd, or asic.
 info.system
string
System of your worker, for example windows, linux, or antminer.
 info.status
string
Status of your worker, for example online, offline, or idle.
 info.inactive
integer
0 (false) or 1 (true) if the worker is inactive.
 info.status_reason
string
Information on special worker's status, such as switching, unauthorized, etc.
 info.status_cpu
string
Status of your worker's CPU, for example online or idle.
 info.uptime
string
Uptime in descriptive format.
 info.sync
integer
Number of seconds since the last sync.
 info.time
string
Current time in YYYY-MM-DD hh:mm:ss format.
 info.note
integer
0 (false) or 1 (true) if the worker holds a note.
 info.profit_switch
integer
0 (false) or 1 (true) if the worker has profit switch activated.
 info.name
string
Worker's name as added on dashboard.
 info.version
string
Software version.
 info.groups
string
The list of all groups assigned to the worker. Groups are divided with comma.
 info.cmd
string
 info.electricity
real
Worker's electricity rate in USD as defined in worker's config.
 info.hot
integer
Worker's hot limit in °C as defined in worker's config.
 info.veryHot
integer
Worker's very hot limit in °C as defined in worker's config.
 info.devices
integer
Number of devices (GPUs) connected to the worker as defined in worker's config.
 info.consumption
string
Consumption fixed value or added value as defined in worker's config.
 info.os
object{}
Information on different characteristics of the OS.
  info.os.status
string
Status of the OS, for example online, offline, or idle.
  info.os.sync
integer
Number of seconds since the last sync.
  info.os.uptime
string
Uptime in descriptive format.
  info.os.cpu_temp
integer
Temperature of CPU.
  info.os.cpu_load
integer
Load of CPU.
  info.os.freespace
real
Amount of free space in MB.
  info.os.freemem
real
Amount of free memory in MB.
  info.os.localip
string
Local IP of the worker.
hardware
array[]
The list of all hardware in the mining rig. One worker can hold up to 16 GPUs and one ASIC can have multiple boards.
  hardware[i].name
string
Hardware's name.
  hardware[i].temp
integer
Hardware's temperature in °C.
  hardware[i].temp2
integer
Chip temperature in °C.
  hardware[i].fan
integer
Hardware's fans in % or RPM.
  hardware[i].chips
string
Status of the chips on the ASIC board with values o as operational, x for chips that are not working, and   (empty space) for chips that are not detected.
  hardware[i].power
integer
Hardware's estimated power consumption in W.
  hardware[i].powerMin
integer
Minimum power value as provided by drivers in W.
  hardware[i].powerMax
integer
Maximum power value as provided by drivers in W.
  hardware[i].powerStock
integer
Stock power value as provided by drivers in W.
  hardware[i].speed
real
Hardware's speed (units defined in mining section).
  hardware[i].bus
string
GPU BUS identifier.
  hardware[i].type
string
Type of GPU.
  hardware[i].bios
string
GPU BIOS.
  hardware[i].core
integer
Core clock value in MHz.
  hardware[i].coreMax
integer
Maximum core clock value as provided by drivers in MHz.
  hardware[i].memory
integer
Memory clock value in MHz.
  hardware[i].memoryMax
integer
Maximum memory clock value as provided by drivers in MHz.
  hardware[i].load
integer
GPU load in %.
  hardware[i].vddc
integer
VDDC core voltage value as provided by drivers in MHz.
  hardware[i].mvdd
integer
MVDD memory voltage value as provided by drivers in MHz.
revenue
object{}
Information on the current revenue status.
 revenue.usd_day
real
Current USD/day earnings for all coins that are being mined (including dual coin and CPU coin).
 revenue.usd_day_dual
real
Current USD/day earnings for second coin in dual mining.
 revenue.usd_day_cpu
real
Current USD/day earnings for coin in CPU mining.
 revenue.usd_week
real
Current USD/week earnings for all coins that are being mined (including dual coin and CPU coin).
 revenue.usd_month
real
Current USD/month earnings for all coins that are being mined (including dual coin and CPU coin).
 revenue.usd_month_dual
real
Current USD/month earnings for second coin in dual mining.
 revenue.usd_month_cpu
real
Current USD/month earnings for coin in CPU mining.
 revenue.btc_day
real
Current BTC/day earnings for all coins that are being mined (including dual coin and CPU coin).
 revenue.btc_week
real
Current BTC/week earnings for all coins that are being mined (including dual coin and CPU coin).
 revenue.btc_month
real
Current BTC/month earnings for all coins that are being mined (including dual coin and CPU coin).
 revenue.coin
real
Current amount of main coin mined in one day.
 revenue.coin_dual
real
Current amount of dual coin mined in one day.
 revenue.coin_cpu
real
Current amount of CPU coin mined in one day.
 revenue.cprice
real
Current exchange rate of the main coin.
 revenue.cprice_dual
real
Current exchange rate of the dual coin.
 revenue.cprice_cpu
real
Current exchange rate of the CPU coin.
mining
object{}
Information on the current mining status.
 mining.client
string
Mining client that is used for mining main and/or dual coin.
 mining.client_version
string
Version of the mining client being used for mining main and/or dual coin.
 mining.client_cpu
string
Mining client that is used for mining with CPU.
 mining.client_cpu_version
string
Version of the mining client being used for mining with CPU.
 mining.crypto
string
Main coin mined with GPU rig or ASIC.
 mining.crypto_dual
string
Dual coin mined with GPU rig.
 mining.crypto_cpu
string
CPU coin mined with GPU rig.
 mining.pool
string
Address of the pool the worker is currently mining on.
 mining.pool_dual
string
Address of the pool the worker is currently mining on with dual mining.
 mining.pool_cpu
string
Address of the pool the worker is currently mining on with CPU mining.
 mining.hashrate
object{}
Information on current hashrates.
  mining.hashrate.hashrate
real
Current hashrate of main coin.
  mining.hashrate.hashrate_unit
string
Units of the current hashrate of main coin.
  mining.hashrate.hashrate_dual
real
Current hashrate of dual coin.
  mining.hashrate.hashrate_unit_dual
string
Units of the current hashrate of dual coin.
  mining.hashrate.hashrate_cpu
real
Current hashrate of CPU coin.
  mining.hashrate.hashrate_unit_cpu
string
Units of the current hashrate of CPU coin.
 mining.shares
object{}
Information on current shares.
  mining.shares.accepted_share
integer
Number of accepted shares on main coin.
  mining.shares.accepted_share_dual
integer
Number of accepted shares on dual coin.
  mining.shares.accepted_share_cpu
integer
Number of accepted shares on CPU coin.
  mining.shares.rejected_share
integer
Number of rejected shares on main coin.
  mining.shares.rejected_share_dual
integer
Number of rejected shares on dual coin.
  mining.shares.rejected_share_cpu
integer
Number of rejected shares on CPU coin.