ArtistsAPI¶

class minim.api.deezer.ArtistsAPI(client: APIClient, /)[source]¶

Bases: DeezerResourceAPI

Artists API endpoints for the Deezer API.

Important

This class is managed by DeezerAPIClient and should not be instantiated directly.

Parameters:

clientminim.api._shared.APIClient: API client instance used to make HTTP requests.

Methods

`follow_artists`	User > Artists: Favorite one or more artists.
`get_artist`	Artist: Get Deezer catalog information for an artist.
`get_artist_albums`	Artist > Albums: Get Deezer catalog information for albums by an artist.
`get_artist_fans`	Artist > Fans: Get Deezer profile information for fans of an artist.
`get_artist_playlists`	Artist > Playlists: Get Deezer catalog information for playlists featuring an artist.
`get_artist_radio_tracks`	Artist > Radio: Get Deezer catalog information for algorithmically selected tracks in an artist's radio.
`get_artist_top_tracks`	Artist > Top: Get Deezer catalog information for top tracks by an artist.
`get_similar_artists`	Artist > Related: Get Deezer catalog information for similar artists.
`get_top_artists`	Chart > Artists: Get Deezer catalog information for the top artists on Deezer.
`get_user_artist_recommendations`	User > Recommendations > Artists: Get Discogs catalog information for artists recommended for a user.
`get_user_followed_artists`	User > Artists: Get Deezer catalog information for a user's favorite artists.
`get_user_top_artists`	User > Charts > Artists: Get Deezer catalog information for a user's top artists on Deezer.
`unfollow_artist`	User > Artists: Unfavorite an artist.

follow_artists(artist_ids: int | str | Collection[int | str], /, *, user_id: int | str = 'me') → bool[source]¶

User > Artists: Favorite one or more artists.

Permission

Required

manage_library permission: Manage a user’s library. Learn more.

Parameters:

artist_idsint, str, or Collection[int | str]; positional-only

Deezer IDs of the artists.

Examples: 3265001, "330311461", "3265001,330311461", [3265001, "330311461"].

user_idint or str; keyword-only; default: "me"

Deezer ID of the user. If authenticated, "me" can be used in lieu of a Deezer ID for the current user.

Example: 5395005364, "5395005364", "me".

Returns:

successbool: Whether the artists were favorited successfully.

get_artist(artist_id: int | str, /) → dict[str, Any][source]¶

Artist: Get Deezer catalog information for an artist.

Parameters:

artist_idint or str; positional-only

Deezer ID of the artist.

Examples: 3265001, "330311461".

Returns:

artistdict[str, Any]

Deezer metadata for the artist.

Sample response

{
  "id": <int>,
  "link": <str>,
  "name": <str>,
  "nb_album": <int>,
  "nb_fan": <int>,
  "picture": <str>,
  "picture_big": <str>,
  "picture_medium": <str>,
  "picture_small": <str>,
  "picture_xl": <str>,
  "radio": <bool>,
  "share": <str>,
  "tracklist": <str>,
  "type": "artist"
}

get_artist_albums(artist_id: int | str, /, *, limit: int | None = None, offset: int | None = None) → dict[str, Any][source]¶

Artist > Albums: Get Deezer catalog information for albums by an artist.

Parameters:

artist_idint or str; positional-only

Deezer ID of the artist.

Examples: 3265001, "330311461".

limitint; keyword-only; optional

Maximum number of albums to return.

Minimum value: 1.

API default: 25.

offsetint; keyword-only; optional

Index of the first album to return. Use with limit to get the next batch of albums.

Minimum value: 0.

API default: 0.

Returns:

albumsdict[str, Any]

Page of Deezer metadata for the artist’s albums.

Sample response

{
  "data": [
    {
      "cover": <str>,
      "cover_big": <str>,
      "cover_medium": <str>,
      "cover_small": <str>,
      "cover_xl": <str>,
      "explicit_lyrics": <bool>,
      "fans": <int>,
      "genre_id": <int>,
      "id": <int>,
      "link": <str>,
      "md5_image": <str>,
      "record_type": <str>,
      "release_date": <str>,
      "title": <str>,
      "tracklist": <str>,
      "type": "album"
    }
  ],
  "prev": <str>,
  "next": <str>,
  "total": <int>
}

get_artist_fans(artist_id: int | str, /, *, limit: int | None = None, offset: int | None = None) → dict[str, Any][source]¶

Artist > Fans: Get Deezer profile information for fans of an artist.

Parameters:

artist_idint or str; positional-only

Deezer ID of the artist.

Examples: 3265001, "330311461".

limitint; keyword-only; optional

Maximum number of users to return.

Minimum value: 1.

offsetint; keyword-only; optional

Index of the first user to return. Use with limit to get the next batch of users.

Minimum value: 0.

API default: 0.

Returns:

usersdict[str, Any]

Page of Deezer profile information for the artist’s fans.

Sample response

{
  "data": [
    {
      "id": <int>,
      "name": <str>,
      "picture": <str>,
      "picture_big": <str>,
      "picture_medium": <str>,
      "picture_small": <str>,
      "picture_xl": <str>,
      "tracklist": <str>,
      "type": "user"
    }
  ],
  "next": <str>,
  "prev": <str>,
  "total": <int>
}

get_artist_playlists(artist_id: int | str, /, *, limit: int | None = None, offset: int | None = None) → dict[str, Any][source]¶

Artist > Playlists: Get Deezer catalog information for playlists featuring an artist.

Parameters:

artist_idint or str; positional-only

Deezer ID of the artist.

Examples: 3265001, "330311461".

limitint; keyword-only; optional

Maximum number of playlists to return.

Minimum value: 1.

API default: 10.

offsetint; keyword-only; optional

Index of the first playlist to return. Use with limit to get the next batch of playlists.

Minimum value: 0.

API default: 0.

Returns:

playlistsdict[str, Any]

Page of Deezer metadata for the playlists featuring the artist.

Sample response

{
  "data": [
    {
      "add_date": <str>,
      "checksum": <str>,
      "creation_date": <str>,
      "id": <int>,
      "link": <str>,
      "md5_image": <str>,
      "mod_date": <str>,
      "picture": <str>,
      "picture_big": <str>,
      "picture_medium": <str>,
      "picture_small": <str>,
      "picture_type": <str>,
      "picture_xl": <str>,
      "public": <bool>,
      "title": <str>,
      "tracklist": <str>,
      "type": "playlist"
      "user": {
        "id": <int>,
        "name": <str>,
        "tracklist": <str>,
        "type": "user"
      }
    }
  ],
  "prev": <str>,
  "next": <str>,
  "total": <int>
}

get_artist_radio_tracks(artist_id: int | str, /, *, limit: int | None = None, offset: int | None = None) → dict[str, Any][source]¶

Artist > Radio: Get Deezer catalog information for algorithmically selected tracks in an artist’s radio.

Parameters:

artist_idint or str; positional-only

Deezer ID of the artist.

Examples: 3265001, "330311461".

limitint; keyword-only; optional

Maximum number of tracks to return.

Minimum value: 1.

API default: 25.

offsetint; keyword-only; optional

Index of the first track to return. Use with limit to get the next batch of tracks.

Minimum value: 0.

API default: 0.

Returns:

tracksdict[str, Any]

Page of Deezer metadata for the tracks in the artist’s radio.

Sample response

{
  "data": [
    {
      "album": {
        "cover": <str>,
        "cover_big": <str>,
        "cover_medium": <str>,
        "cover_small": <str>,
        "cover_xl": <str>,
        "id": <int>,
        "md5_image": <str>,
        "title": <str>,
        "tracklist": <str>,
        "type": "album"
      },
      "artist": {
        "id": <int>,
        "name": <str>,
        "picture": <str>,
        "picture_big": <str>,
        "picture_medium": <str>,
        "picture_small": <str>,
        "picture_xl": <str>,
        "tracklist": <str>,
        "type": "artist"
      },
      "duration": <int>,
      "explicit_content_cover": <int>,
      "explicit_content_lyrics": <int>,
      "explicit_lyrics": <bool>,
      "id": <int>,
      "md5_image": <str>,
      "preview": <str>,
      "rank": <int>,
      "readable": <bool>,
      "title": <str>,
      "title_short": <str>,
      "title_version": <str>,
      "type": "track"
    }
  ]
}

get_artist_top_tracks(artist_id: int | str, /, *, limit: int | None = None, offset: int | None = None) → dict[str, Any][source]¶

Artist > Top: Get Deezer catalog information for top tracks by an artist.

Parameters:

artist_idint or str; positional-only

Deezer ID of the artist.

Examples: 3265001, "330311461".

limitint; keyword-only; optional

Maximum number of tracks to return.

Minimum value: 1.

API default: 5.

offsetint; keyword-only; optional

Index of the first track to return. Use with limit to get the next batch of tracks.

Minimum value: 0.

API default: 0.

Returns:

top_tracksdict[str, Any]

Page of Deezer metadata for the artist’s top tracks.

Sample response

{
  "data": [
    {
      "album": {
        "cover": <str>,
        "cover_big": <str>,
        "cover_medium": <str>,
        "cover_small": <str>,
        "cover_xl": <str>,
        "id": <int>,
        "md5_image": <str>,
        "title": <str>,
        "tracklist": <str>,
        "type": "album"
      },
      "artist": {
        "id": <int>,
        "name": <str>,
        "tracklist": <str>,
        "type": "artist"
      },
      "contributors": [
        {
          "id": <int>,
          "link": <str>,
          "name": <str>,
          "picture": <str>,
          "picture_big": <str>,
          "picture_medium": <str>,
          "picture_small": <str>,
          "picture_xl": <str>,
          "radio": <bool>,
          "role": <str>,
          "share": <str>,
          "tracklist": <str>,
          "type": "artist"
        }
      ],
      "duration": <int>,
      "explicit_content_cover": <int>,
      "explicit_content_lyrics": <int>,
      "explicit_lyrics": <bool>,
      "id": <int>,
      "md5_image": <str>,
      "preview": <str>,
      "rank": <int>,
      "readable": <bool>,
      "title": <str>,
      "title_short": <str>,
      "title_version": <str>,
      "type": "track"
    }
  ],
  "prev": <str>,
  "next": <str>,
  "total": <int>
}

get_similar_artists(artist_id: int | str, /, *, limit: int | None = None, offset: int | None = None) → dict[str, Any][source]¶

Artist > Related: Get Deezer catalog information for similar artists.

Parameters:

artist_idint or str; positional-only

Deezer ID of the artist.

Examples: 3265001, "330311461".

limitint; keyword-only; optional

Maximum number of artists to return.

Minimum value: 1.

API default: 20.

offsetint; keyword-only; optional

Index of the first artist to return. Use with limit to get the next batch of artists.

Minimum value: 0.

API default: 0.

Returns:

artistsdict[str, Any]

Page of Deezer metadata for the similar artists.

Sample response

{
  "data": [
    {
      "id": <int>,
      "link": <str>,
      "name": <str>,
      "nb_album": <int>,
      "nb_fan": <int>,
      "picture": <str>,
      "picture_big": <str>,
      "picture_medium": <str>,
      "picture_small": <str>,
      "picture_xl": <str>,
      "radio": <bool>,
      "tracklist": <str>,
      "type": "artist"
    }
  ],
  "next": <str>,
  "prev": <str>,
  "total": <int>
}

get_top_artists(*, limit: int | None = None, offset: int | None = None) → dict[str, Any][source]¶

Chart > Artists: Get Deezer catalog information for the top artists on Deezer.

Parameters:

limitint; keyword-only; optional

Maximum number of artists to return.

Minimum value: 1.

API default: 10.

offsetint; keyword-only; optional

Index of the first artist to return. Use with limit to get the next batch of artists.

Minimum value: 0.

API default: 0.

Returns:

artistsdict[str, Any]

Page of Deezer metadata for the top artists.

Sample response

{
  "data": [
    {
      "id": <int>,
      "link": <str>,
      "name": <str>,
      "picture": <str>,
      "picture_big": <str>,
      "picture_medium": <str>,
      "picture_small": <str>,
      "picture_xl": <str>,
      "position": <int>,
      "radio": <bool>,
      "tracklist": <str>,
      "type": "artist"
    }
  ],
  "prev": <str>,
  "next": <str>,
  "total": <int>
}

get_user_artist_recommendations(user_id: int | str = 'me', /, *, limit: int | None = None, offset: int | None = None) → dict[str, Any][source]¶

User > Recommendations > Artists: Get Discogs catalog information for artists recommended for a user.

User authentication

Required

User authentication: Access the user’s favorite items, playlists, and followed people.

Parameters:

user_idint or str; positional-only; default: "me"

Deezer ID of the user. If authenticated, "me" can be used in lieu of a Deezer ID for the current user.

Example: 5395005364, "5395005364", "me".

limitint; keyword-only; optional

Maximum number of artists to return.

Minimum value: 1.

offsetint; keyword-only; optional

Index of the first artist to return. Use with limit to get the next batch of artists.

Minimum value: 0.

API default: 0.

Returns:

artistsdict[str, Any]

Page of Deezer metadata for the recommended artists.

Sample response

{
  "data": [
    {
      "id": <int>,
      "link": <str>,
      "name": <str>,
      "nb_album": <int>,
      "nb_fan": <int>,
      "picture": <str>,
      "picture_big": <str>,
      "picture_medium": <str>,
      "picture_small": <str>,
      "picture_xl": <str>,
      "radio": <bool>,
      "timestamp": <int>,
      "tracklist": <str>,
      "type": "artist"
    }
  ],
  "next": <str>,
  "prev": <str>,
  "total": <int>
}

get_user_followed_artists(user_id: int | str = 'me', /, *, limit: int | None = None, offset: int | None = None) → dict[str, Any][source]¶

User > Artists: Get Deezer catalog information for a user’s favorite artists.

User authentication

Required

User authentication: Access the user’s favorite items, playlists, and followed people.

Parameters:

user_idint or str; positional-only; default: "me"

Deezer ID of the user. If authenticated, "me" can be used in lieu of a Deezer ID for the current user.

Example: 5395005364, "5395005364", "me".

limitint; keyword-only; optional

Maximum number of artists to return.

Minimum value: 1.

offsetint; keyword-only; optional

Index of the first artist to return. Use with limit to get the next batch of artists.

Minimum value: 0.

API default: 0.

Returns:

artistsdict[str, Any]

Page of Deezer metadata for the user’s favorite artists.

Sample response

{
  "checksum": <str>,
  "data": [
    {
      "id": <int>,
      "link": <str>,
      "name": <str>,
      "nb_album": <int>,
      "nb_fan": <int>,
      "picture": <str>,
      "picture_big": <str>,
      "picture_medium": <str>,
      "picture_small": <str>,
      "picture_xl": <str>,
      "radio": <bool>,
      "time_add": <int>,
      "tracklist": <str>,
      "type": "artist"
    }
  ],
  "next": <str>,
  "prev": <str>,
  "total": <int>
}

get_user_top_artists(user_id: int | str = 'me', /, *, limit: int | None = None, offset: int | None = None) → dict[str, Any][source]¶

User > Charts > Artists: Get Deezer catalog information for a user’s top artists on Deezer.

User authentication

Required

User authentication: Access the user’s favorite items, playlists, and followed people.

Parameters:

user_idint or str; positional-only; default: "me"

Deezer ID of the user. If authenticated, "me" can be used in lieu of a Deezer ID for the current user.

Example: 5395005364, "5395005364", "me".

limitint; keyword-only; optional

Maximum number of artists to return.

Minimum value: 1.

offsetint; keyword-only; optional

Index of the first artist to return. Use with limit to get the next batch of artists.

Minimum value: 0.

API default: 0.

Returns:

artistsdict[str, Any]

Page of Deezer metadata for the user’s top artists.

Sample response

{
  "checksum": <str>,
  "data": [
    {
      "id": <int>,
      "link": <str>,
      "name": <str>,
      "nb_album": <int>,
      "nb_fan": <int>,
      "picture": <str>,
      "picture_big": <str>,
      "picture_medium": <str>,
      "picture_small": <str>,
      "picture_xl": <str>,
      "radio": <bool>,
      "tracklist": <str>,
      "type": "artist"
    }
  ],
  "next": <str>,
  "prev": <str>,
  "total": <int>
}

unfollow_artist(artist_id: int | str, /, *, user_id: int | str = 'me') → bool[source]¶

User > Artists: Unfavorite an artist.

Permissions

Required

manage_library permission: Manage a user’s library. Learn more.
delete_library permission: Delete items from a user’s library. Learn more.

Parameters:

artist_idint or str; positional-only

Deezer ID of the artist.

Examples: 3265001, "330311461".

user_idint or str; keyword-only; default: "me"

Deezer ID of the user. If authenticated, "me" can be used in lieu of a Deezer ID for the current user.

Example: 5395005364, "5395005364", "me".

Returns:

successbool: Whether the artist was unfavorited successfully.