Worker
This is a detailed documentation on how you can check different parameters of your worker. The result of this endpoint is object with one element. The 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}/{WORKER_NAME}
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.
Required
{WORKER_NAME}string
This is the name of your worker. API won't return any result if you didn't add a worker with this name in your minerstat dashboard.
Example call
https://api.minerstat.com/v2/stats/4cc355k3y/Worker001
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
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
{
"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
}
}
}
}
Parameter
Type
Description
infoobject{}
Information on different system characteristics of a worker.
info.typestring
Type of your worker, for example nvidia, amd, or asic.
info.systemstring
System of your worker, for example windows, linux, or antminer.
info.statusstring
Status of your worker, for example online, offline, or idle.
info.inactiveinteger
0 (false) or 1 (true) if the worker is inactive.
info.status_reasonstring
Information on special worker's status, such as switching, unauthorized, etc.
info.status_cpustring
Status of your worker's CPU, for example online or idle.
info.uptimestring
Uptime in descriptive format.
info.syncinteger
Number of seconds since the last sync.
info.timestring
Current time in YYYY-MM-DD hh:mm:ss format.
info.noteinteger
0 (false) or 1 (true) if the worker holds a note.
info.profit_switchinteger
0 (false) or 1 (true) if the worker has profit switch activated.
info.namestring
Worker's name as added on dashboard.
info.versionstring
Software version.
info.groupsstring
The list of all groups assigned to the worker. Groups are divided with comma.
info.cmdstring
info.electricityreal
Worker's electricity rate in USD as defined in worker's config.
info.hotinteger
Worker's hot limit in °C as defined in worker's config.
info.veryHotinteger
Worker's very hot limit in °C as defined in worker's config.
info.devicesinteger
Number of devices (GPUs) connected to the worker as defined in worker's config.
info.consumptionstring
Consumption fixed value or added value as defined in worker's config.
info.osobject{}
Information on different characteristics of the OS.
info.os.statusstring
Status of the OS, for example online, offline, or idle.
info.os.syncinteger
Number of seconds since the last sync.
info.os.uptimestring
Uptime in descriptive format.
info.os.cpu_tempinteger
Temperature of CPU.
info.os.cpu_loadinteger
Load of CPU.
info.os.freespacereal
Amount of free space in MB.
info.os.freememreal
Amount of free memory in MB.
info.os.localipstring
Local IP of the worker.
info.authobject{}
Auth information for ASIC machine.
info.auth.userstring
Username.
info.auth.userstring
Password.
hardwarearray[]
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].namestring
Hardware's name.
hardware[i].tempinteger
Hardware's temperature in °C.
hardware[i].temp2integer
Chip temperature in °C.
hardware[i].memTempinteger
Memory temperature in °C.
hardware[i].faninteger
Hardware's fans in % or RPM.
hardware[i].chipsstring
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].powerinteger
Hardware's estimated power consumption in W.
hardware[i].powerMininteger
Minimum power value as provided by drivers in W.
hardware[i].powerMaxinteger
Maximum power value as provided by drivers in W.
hardware[i].powerStockinteger
Stock power value as provided by drivers in W.
hardware[i].speedreal
Hardware's speed (units defined in mining section).
hardware[i].busstring
GPU BUS identifier.
hardware[i].typestring
Type of GPU.
hardware[i].biosstring
GPU BIOS.
hardware[i].coreinteger
Core clock value in MHz.
hardware[i].coreMaxinteger
Maximum core clock value as provided by drivers in MHz.
hardware[i].memoryinteger
Memory clock value in MHz.
hardware[i].memoryMaxinteger
Maximum memory clock value as provided by drivers in MHz.
hardware[i].loadinteger
GPU load in %.
hardware[i].vddcinteger
VDDC core voltage value as provided by drivers in MHz.
hardware[i].mvddinteger
MVDD memory voltage value as provided by drivers in MHz.
revenueobject{}
Information on the current revenue status.
revenue.usd_dayreal
Current USD/day earnings for all coins that are being mined (including dual coin and CPU coin).
revenue.usd_day_dualreal
Current USD/day earnings for second coin in dual mining.
revenue.usd_day_cpureal
Current USD/day earnings for coin in CPU mining.
revenue.usd_weekreal
Current USD/week earnings for all coins that are being mined (including dual coin and CPU coin).
revenue.usd_monthreal
Current USD/month earnings for all coins that are being mined (including dual coin and CPU coin).
revenue.usd_month_dualreal
Current USD/month earnings for second coin in dual mining.
revenue.usd_month_cpureal
Current USD/month earnings for coin in CPU mining.
revenue.btc_dayreal
Current BTC/day earnings for all coins that are being mined (including dual coin and CPU coin).
revenue.btc_weekreal
Current BTC/week earnings for all coins that are being mined (including dual coin and CPU coin).
revenue.btc_monthreal
Current BTC/month earnings for all coins that are being mined (including dual coin and CPU coin).
revenue.coinreal
Current amount of main coin mined in one day.
revenue.coin_dualreal
Current amount of dual coin mined in one day.
revenue.coin_cpureal
Current amount of CPU coin mined in one day.
revenue.cpricereal
Current exchange rate of the main coin.
revenue.cprice_dualreal
Current exchange rate of the dual coin.
revenue.cprice_cpureal
Current exchange rate of the CPU coin.
miningobject{}
Information on the current mining status.
mining.clientstring
Mining client that is used for mining main and/or dual coin.
mining.client_versionstring
Version of the mining client being used for mining main and/or dual coin.
mining.client_cpustring
Mining client that is used for mining with CPU.
mining.client_cpu_versionstring
Version of the mining client being used for mining with CPU.
mining.cryptostring
Main coin mined with GPU rig or ASIC.
mining.crypto_dualstring
Dual coin mined with GPU rig.
mining.crypto_cpustring
CPU coin mined with GPU rig.
mining.poolstring
Address of the pool the worker is currently mining on.
mining.pool_dualstring
Address of the pool the worker is currently mining on with dual mining.
mining.pool_cpustring
Address of the pool the worker is currently mining on with CPU mining.
mining.hashrateobject{}
Information on current hashrates.
mining.hashrate.hashratereal
Current hashrate of main coin.
mining.hashrate.hashrate_unitstring
Units of the current hashrate of main coin.
mining.hashrate.hashrate_dualreal
Current hashrate of dual coin.
mining.hashrate.hashrate_unit_dualstring
Units of the current hashrate of dual coin.
mining.hashrate.hashrate_cpureal
Current hashrate of CPU coin.
mining.hashrate.hashrate_unit_cpustring
Units of the current hashrate of CPU coin.
mining.sharesobject{}
Information on current shares.
mining.shares.accepted_shareinteger
Number of accepted shares on main coin.
mining.shares.accepted_share_dualinteger
Number of accepted shares on dual coin.
mining.shares.accepted_share_cpuinteger
Number of accepted shares on CPU coin.
mining.shares.rejected_shareinteger
Number of rejected shares on main coin.
mining.shares.rejected_share_dualinteger
Number of rejected shares on dual coin.
mining.shares.rejected_share_cpuinteger
Number of rejected shares on CPU coin.