10

REST API

selfhoster edited this page 2020-01-11 00:21:26 +00:00

Table of Contents

• REST API
• Postman API Collection
• Import from link:
• Add URLs to download queue:
• Quality variable accepts lossless,flac or 320,mp3 or 128, and is case insensitive (also accepts FLAC and lOsSlEsS, etc.)
• Search for a track, album, playlist or artist
• Retrieve tracklist for an album, artist, playlist or spotifyplaylist
• Retrieve length of, and items in Download Queue
• Remove item from Download Queue
• Clear Download Queue

REST API

Postman API Collection

Import from link:

https://notabug.org/RemixDevs/DeezloaderRemix/raw/83709ab32a3c17e70d1a1dcadb8de4ab285b5651/DeezloaderRemix.postman_collection.json

Add URLs to download queue:

Quality variable accepts lossless,flac or 320,mp3 or 128, and is case insensitive (also accepts FLAC and lOsSlEsS, etc.)

POST http://localhost:1730/api/download/
Content-Type: application/json

{
    "url": "https://www.deezer.com/album/115542362",
    "quality": "flac"   //OPTIONAL
}
    or
{
    "url": ["https://www.deezer.com/track/812778162","https://www.deezer.com/playlist/708702152","https://www.deezer.com/track/813185722"]
}

or

GET http://localhost:1730/api/download/?url=https://www.deezer.com/album/115542362
or
GET http://localhost:1730/api/download/?url=https://www.deezer.com/album/115542362&quality=flac

Search for a track, album, playlist or artist

POST http://localhost:1730/api/search/
Content-Type: application/json

{
    "album": "my favourite album - my favouite artist"
}
    or
{
    "artist": "my favouite artist"
}

or

GET http://localhost:1730/api/search/?album=my favourite album - my favouite artist

Retrieve tracklist for an album, artist, playlist or spotifyplaylist

POST http://localhost:1730/api/tracks/
Content-Type: application/json

{
    "album": "my favourite album's ID"
}
    or
{
    "artist": "my favouite artist's ID"
}

or

GET http://localhost:1730/api/tracks/?album=115542362

Retrieve length of, and items in Download Queue

GET http://localhost:1730/api/queue/

Remove item from Download Queue

POST http://localhost:1730/api/canceldownload/
Content-Type: application/json

{
    "queueId": "ida33m5l8firh"
}

or

GET http://localhost:1730/api/canceldownload/?queueId=ida33m5l8firh

Clear Download Queue

GET http://localhost:1730/api/clearqueue/