User#

class deezer.User(client, json)#

To work with Deezer user objects.

Check the Deezer documentation for more details about each field.

id: int#
name: str#
lastname: str | None#
firstname: str | None#
email: str | None#
status: int | None#
birthday: dt.date | None#
inscription_date: dt.date#
gender: str | None#
picture: str#
picture_small: str#
picture_medium: str#
picture_big: str#
picture_xl: str#
country: str#
lang: str | None#
is_kid: bool | None#
explicit_content_level: str | None#
explicit_content_levels_available: list[str] | None#
tracklist: str#
get_albums(**kwargs)#

Get user’s favorite albums.

Returns:

a PaginatedList of Album instances

Return type:

PaginatedList[Album]

add_album(album)#

Add an album to user’s favorite albums.

Parameters:

album (Album | int) – an Album instance or its ID

Returns:

a boolean that tells if the operation was successful

remove_album(album)#

Remove an album from user’s favorite albums.

Parameters:

album (Album | int) – an Album instance or its ID

Returns:

a boolean that tells if the operation was successful

get_tracks(**kwargs)#

Get user’s favorite tracks.

Returns:

a PaginatedList of Track instances

Return type:

PaginatedList[Track]

add_track(track)#

Add a track to user’s favorite tracks.

Parameters:

track (Track | int) – a Track instance or its ID

Returns:

a boolean that tells if the operation was successful

remove_track(track)#

Remove a track from user’s favorite tracks.

Parameters:

track (Track | int) – a Track instance or its ID

Returns:

a boolean that tells if the operation was successful

get_artists(**kwargs)#

Get user’s favorite artists.

Returns:

a PaginatedList of Artist instances

Return type:

PaginatedList[Artist]

add_artist(artist)#

Add an artist to user’s favorite artists.

Parameters:

artist (Artist | int) – an Artist instance or its ID

Returns:

a boolean that tells if the operation was successful

remove_artist(artist)#

Remove an artist from user’s favorite artists.

Parameters:

artist (Artist | int) – an Artist instance or its ID

Returns:

a boolean that tells if the operation was successful

get_followers(**kwargs)#

Get user’s followers.

Returns:

a PaginatedList of User instances

Return type:

PaginatedList[User]

get_followings(**kwargs)#

Get user’s followings.

Returns:

a PaginatedList of User instances

Return type:

PaginatedList[User]

follow(user)#

Follow a user.

Parameters:

user (User | int) – a User instance or its ID

Returns:

a boolean that tells if the operation was successful

unfollow(user)#

Unfollow a user.

Parameters:

user (User | int) – a User instance or its ID

Returns:

a boolean that tells if the operation was successful

get_playlists(**kwargs)#

Get user’s public playlists.

Returns:

a PaginatedList of Playlist instances

Return type:

PaginatedList[Playlist]

add_playlist(playlist)#

Add a playlist to user’s public playlists.

Parameters:

playlist (Playlist | int) – a Playlist instance or its ID

Returns:

a boolean that tells if the operation was successful

remove_playlist(playlist)#

Remove a playlist from user’s public playlists.

Parameters:

playlist (Playlist | int) – a Playlist instance or its ID

Returns:

a boolean that tells if the operation was successful

create_playlist(title)#

Create a playlist.

Parameters:

title (str) – the title of the playlist

Returns:

the ID of the playlist that was created

Return type:

int