Ecosystem/xmrig
Ecosystem/xmrig
1
0
Fork 0
mirror of https://github.com/xmrig/xmrig.git synced 2024-12-22 19:49:36 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated API (markdown)

xmrig 2019-08-17 20:25:44 +07:00
parent 22e4e8a23e
commit add3057169
1 changed files with 1 additions and 102 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

103
API.md

@ -1,102 +1 @@
In version **2.4.0** added HTTP API. If you build miner from source, **libmicrohttpd** dependency added. If you want use API you need choice a port where is internal HTTP server will listen for incoming connections.
Example configuration:
```json
"api": {
"port": 8080,
"access-token": "Optional Bearer Token used for authorization",
"worker-id": "Optional miner name"
}
```
If you prefer use command line options instead of config file, you can use options: `--api-port`, `--api-access-token` and `--api-worker-id`.
### GET / endpoint
```json
{
"id": "150216641909d91c",
"worker_id": "worker",
"version": "2.4.0",
"kind": "cpu",
"ua": "XMRig/2.4.0-dev (Linux x86_64) libuv/1.8.0 gcc/5.4.0",
"cpu": {
"brand": "Intel(R) Core(TM) i7-6700 CPU @ 3.40GHz",
"aes": true,
"x64": true,
"sockets": 1
},
"algo": "cryptonight",
"hugepages": true,
"donate": 5,
"hashrate": {
"total": [
232.1,
252.6,
252.8
],
"highest": 274.1,
"threads": [
[
57.1,
62.5,
62.9
],
[
58.8,
62.5,
63.1
],
[
57.2,
63.7,
63.5
],
[
58.9,
63.7,
63.2
]
]
},
"results": {
"diff_current": 10000,
"shares_good": 1849,
"shares_total": 1849,
"avg_time": 41,
"hashes_total": 18490000,
"best": [
10674268,
5505855,
5346760,
4975689,
4011628,
3687853,
3148608,
2876595,
2619473,
2451160
],
"error_log": []
},
"connection": {
"pool": "pool.minemonero.pro:5555",
"uptime": 75884,
"ping": 25,
"failures": 0,
"error_log": []
}
}
```
NVIDIA miner has equal API, with additional GPU health information.
```json
"health": [
{
"name": "GeForce GTX 1050 Ti",
"clock": 1721,
"mem_clock": 3504,
"power": 46,
"temp": 60,
"fan": 41
}
],
```
* https://github.com/xmrig/xmrig/blob/master/doc/API.md