mirror/Lidarr
1
0
Fork 0
mirror of https://github.com/lidarr/Lidarr synced 2024-12-22 15:53:23 +00:00
Code Issues Releases Wiki Activity

Updated Album Lookup (markdown)

Qstick 2018-04-14 23:39:29 -04:00
parent 0530cfc851
commit 6bb3cbd193
1 changed files with 119 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

127
Album-Lookup.md

@ -1,23 +1,134 @@
**Endpoint: "/album/lookup"**
**Endpoint: "/Album/lookup"**
## GET ##
##### Summary #####
Search for album by name or id
Searches for new albums on Lidarr API
##### Parameters ######
*None*
Required:
`term` = Either the Album's Name, using `%20` to signify spaces, as in `term=Hybrid%20Theory`
##### Returns JsonArray ######
Or you can use `lidarr:b5b4bb4b-8ba5-3acf-88cb-4cae2699d8da` if you know the album's MusicBrainz ID Number - as in `term=lidarr:b5b4bb4b-8ba5-3acf-88cb-4cae2699d8da`
#### Full Breakdown: ####
```
curl --request GET "localhost:8686/api/v1/Artist/lookup?term=Hybrid%20Theory&apikey=YOURAPIKEY"
```
-- or --
```
curl --request GET "localhost:8686/api/v1/Artist/lookup?term=lidarr:b5b4bb4b-8ba5-3acf-88cb-4cae2699d8da&apikey=YOURAPIKEY"
```
##### Returns Array ######
```JSON
[
{
"path": "C:\\",
"label": "",
"freeSpace": 282500067328,
"totalSpace": 499738734592
"status": "continuing",
"ended": false,
"artistName": "Hybrid Theory",
"foreignArtistId": "fe008f22-07be-46f0-9206-7cab2d26e89d",
"tadbId": 0,
"discogsId": 0,
"overview": "",
"artistType": "Group",
"disambiguation": "previous name of Linkin Park",
"links": [
{
"url": "https://www.discogs.com/artist/901845",
"name": "discogs"
}
],
"images": [],
"qualityProfileId": 0,
"languageProfileId": 0,
"metadataProfileId": 0,
"albumFolder": false,
"monitored": false,
"cleanName": "hybridtheory",
"sortName": "hybrid theory",
"tags": [],
"added": "0001-01-01T00:00:00Z",
"ratings": {
"votes": 0,
"value": 0.0
},
"statistics": {
"albumCount": 0,
"trackFileCount": 0,
"trackCount": 0,
"totalTrackCount": 0,
"sizeOnDisk": 0,
"percentOfTracks": 0.0
}
},
{
"status": "continuing",
"ended": false,
"artistName": "Hybrid Theory",
"foreignArtistId": "544cbe31-9a92-4175-a0b6-f208322d21df",
"tadbId": 0,
"discogsId": 0,
"overview": "",
"artistType": "Group",
"disambiguation": "UK Production Duo",
"links": [
{
"url": "https://www.facebook.com/hybridtheoryuk",
"name": "facebook"
},
{
"url": "https://soundcloud.com/hybridtheoryuk",
"name": "soundcloud"
},
{
"url": "http://hybridtheoryuk.com/",
"name": "hybridtheoryuk"
},
{
"url": "https://www.mixcloud.com/hybridtheoryuk/",
"name": "mixcloud"
},
{
"url": "https://open.spotify.com/artist/6KkbKOCoCyCZGaaWggWh9Q",
"name": "spotify"
},
{
"url": "https://www.beatport.com/artist/hybrid-theory/61187",
"name": "beatport"
},
{
"url": "http://www.junodownload.com/artists/Hybrid+Theory/",
"name": "junodownload"
}
],
"images": [],
"qualityProfileId": 0,
"languageProfileId": 0,
"metadataProfileId": 0,
"albumFolder": false,
"monitored": false,
"cleanName": "hybridtheory",
"sortName": "hybrid theory",
"tags": [],
"added": "0001-01-01T00:00:00Z",
"ratings": {
"votes": 0,
"value": 0.0
},
"statistics": {
"albumCount": 0,
"trackFileCount": 0,
"trackCount": 0,
"totalTrackCount": 0,
"sizeOnDisk": 0,
"percentOfTracks": 0.0
}
}
]
```