From 02bca6bbaaee7302cd4969a0652276059c0bd113 Mon Sep 17 00:00:00 2001
From: xmrig <support@xmrig.com>
Date: Fri, 6 Oct 2017 17:02:51 +0300
Subject: [PATCH] Updated API (markdown)

---
 API.md | 79 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 78 insertions(+), 1 deletion(-)

diff --git a/API.md b/API.md
index 295b74a..f6d8c5c 100644
--- a/API.md
+++ b/API.md
@@ -8,4 +8,81 @@ Example configuration:
     "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`.
\ No newline at end of file
+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": []
+    }
+}
+```
\ No newline at end of file