Search REST API readme 447/head
authorselfhoster <selfhoster@protonmail.com>
Thu, 28 Nov 2019 12:21:24 +0000 (23:21 +1100)
committerselfhoster <selfhoster@protonmail.com>
Thu, 28 Nov 2019 12:21:24 +0000 (23:21 +1100)
README.md

index 00d36798ca9b3cc82d06de00c51c1b9619c0b507..416595ba2f15d7c336ff1baaab167fac878e7f74 100644 (file)
--- a/README.md
+++ b/README.md
@@ -55,9 +55,7 @@ To build the app for other OSs follow the table below
 | macOS              | `npm run dist:macOS` |
 
 ## REST API
-Add URLs to download queue via POST request
-
-Example Request:
+### Add URLs to download queue via POST request:
 ``` JSON
 POST http://localhost:1730/api/download/
 Content-Type: application/json
@@ -71,6 +69,20 @@ Content-Type: application/json
 }
 ```
 
+### Search for a track, album, playlist or artist
+``` JSON
+POST http://localhost:1730/api/search/
+Content-Type: application/json
+
+{
+    "album": "my favourite album - my favouite artist"
+}
+    or
+{
+    "artist": "my favouite artist"
+}
+```
+
 ## Disclaimer
 I am not responsible for the usage of this program by other people.<br/>
 I do not recommend you doing this illegally or against Deezer's terms of service.<br/>