Album - antoineraulin/deezer-api GitHub Wiki
Retrieve information from an album
deezer.get("album",{id: "302127"}) //will retrieve information from album #302127Result :
| Name | Description | Type |
|---|---|---|
| id | The Deezer album id | int |
| title | The album title | string |
| upc | The album UPC | string |
| link | The url of the album on Deezer | url |
| share | The share link of the album on Deezer | url |
| cover | The url of the album's cover. Add 'size' parameter to the url to change size. Can be 'small', 'medium', 'big', 'xl' | url |
| cover_small | The url of the album's cover in size small. | url |
| cover_medium | The url of the album's cover in size medium. | url |
| cover_big | The url of the album's cover in size big. | url |
| cover_xl | The url of the album's cover in size xl. | url |
| genre_id | The album's first genre id (You should use the genre list instead). NB : -1 for not found | int |
| genres | List of genre object | list |
| label | The album's label name | string |
| nb_tracks | int | |
| duration | The album's duration (seconds) | int |
| fans | The number of album's Fans | int |
| rating | The album's rate | int |
| release_date | The album's release date | date |
| record_type | The record type of the album (EP / ALBUM / etc..) | string |
| available | boolean | |
| alternative | Return an alternative album object if the current album is not available | object |
| tracklist | API Link to the tracklist of this album | url |
| explicit_lyrics | Whether the album contains explicit lyrics | boolean |
| explicit_content_lyrics | The explicit content lyrics values (0:Not Explicit; 1:Explicit; 2:Unknown; 3:Edited; 4:Partially Explicit (Album "lyrics" only); 5:Partially Unknown (Album "lyrics" only); 6:No Advice Available; 7:Partially No Advice Available (Album "lyrics" only)) | int |
| explicit_content_cover | The explicit cover values (0:Not Explicit; 1:Explicit; 2:Unknown; 3:Edited; 4:Partially Explicit (Album "lyrics" only); 5:Partially Unknown (Album "lyrics" only); 6:No Advice Available; 7:Partially No Advice Available (Album "lyrics" only)) | int |
| contributors | Return a list of contributors on the album | list |
| artist | artist object containing : id, name, picture, picture_small, picture_medium, picture_big, picture_xl | object |
| tracks | list of track | list |
| id | The track's Deezer id | int |
| readable | true if the track is readable in the player for the current user | boolean |
| title | The track's fulltitle | string |
| title_short | The track's short title | string |
| title_version | The track version | string |
| link | The url of the track on Deezer | url |
| duration | The track's duration in seconds | int |
| rank | The track's Deezer rank | int |
| explicit_lyrics | Whether the track contains explicit lyrics | boolean |
| preview | The url of track's preview file. This file contains the first 30 seconds of the track | url |
| artist | artist object containing : id, name | object |
| Usage | Description | Required params | ||
|---|---|---|---|---|
deezer.post("album",{id:"album_id",note:"your note"}); |
Rate the album | note |
An int [1-5] |
int |
| id |
The album id |
int |
||
| Usage | Description | Required params | ||
|---|---|---|---|---|
deezer.post("user",{method:"albums",album_id:"album_id"}) |
Add an album to the user's library | album_id |
The id of the album |
int |
deezer.delete("user",{method:"albums",album_id:"album_id"}) |
Remove an album from the user's library | album_id |
The id of the album |
int |
-
Return a list of album's comments. Represented by an array of Comment objects
deezer.get("album",{method:"comments",id: "302127"}) //will retrieve comments from album #302127
Name Description Type id The comment's Deezer id int text The content of the comment string date The date the comment was posted timestamp author user object containing : id, name, link, picture, picture_small, picture_medium, picture_big, picture_xl object -
Return a list of album's fans. Represented by an array of User objects
deezer.get("album",{method:"fans",id: "302127"})
Name Description Type id The user's Deezer ID int name The user's Deezer nickname string link The url of the profil for the user on Deezer url picture The url of the user's profil picture. Add 'size' parameter to the url to change size. Can be 'small', 'medium', 'big', 'xl' url picture_small The url of the user's profil picture in size small. url picture_medium The url of the user's profil picture in size medium. url picture_big The url of the user's profil picture in size big. url picture_xl The url of the user's profil picture in size xl. url -
Return a list of album's tracks. Represented by an array of Track objects
deezer.get("album",{method:"tracks",id: "302127"})
Name Description Type id The track's Deezer id int readable true if the track is readable in the player for the current user boolean title The track's fulltitle string title_short The track's short title string title_version The track version string isrc The track isrc string link The url of the track on Deezer url duration The track's duration in seconds int track_position The position of the track in its album int disk_number The track's album's disk number int rank The track's Deezer rank int explicit_lyrics Whether the track contains explicit lyrics boolean preview The url of track's preview file. This file contains the first 30 seconds of the track url alternative Return an alternative readable track if the current track is not readable track artist artist object containing : id, name object