From f5002aac75e25c402294cba1ad06ec9140b9738d Mon Sep 17 00:00:00 2001
From: kenshin-samourai <kenshin_samourai@tutanota.com>
Date: Mon, 20 Jul 2020 16:56:18 +0200
Subject: [PATCH] add doc for /xpub/import/status endpoint

---
 doc/GET_xpub_import_status.md | 37 +++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)
 create mode 100644 doc/GET_xpub_import_status.md

diff --git a/doc/GET_xpub_import_status.md b/doc/GET_xpub_import_status.md
new file mode 100644
index 0000000..4c9849a
--- /dev/null
+++ b/doc/GET_xpub_import_status.md
@@ -0,0 +1,37 @@
+# Get import status for a HD Account
+
+Check if an import or a rescan is currently processed by Dojo for a given HD Account.
+
+```
+GET /xpub/:xpub/import/status
+```
+
+## Parameters
+* **:xpub** - `string` - The extended public key for the HD Account
+* **at** - `string` (optional) - Access Token (json web token). Required if authentication is activated. Alternatively, the access token can be passed through the `Authorization` HTTP header (with the `Bearer` scheme).
+
+### Example
+
+```
+GET /xpub/xpub0123456789/import/status
+```
+
+#### Success
+Status code 200 with JSON response:
+```json
+{
+  "status": "ok",
+  "data": {
+    "import_in_progress": false
+  }
+}
+```
+
+#### Failure
+Status code 400 with JSON response:
+```json
+{
+  "status": "error",
+  "error": "<error message>"
+}
+```