ChartsAPI¶

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

Bases: DeezerResourceAPI

Charts 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

`get_top_albums`	Chart > Albums: Get Deezer catalog information for the top albums on Deezer.
`get_top_artists`	Chart > Artists: Get Deezer catalog information for the top artists on Deezer.
`get_top_playlists`	Chart > Playlists: Get Deezer catalog information for the top playlists on Deezer.
`get_top_podcasts`	Chart > Podcasts: Get Deezer catalog information for the top podcasts on Deezer.
`get_top_radios`	Radio > Top: Get Deezer catalog information for the top radios on Deezer.
`get_top_tracks`	Chart > Tracks: Get Deezer catalog information for the top tracks on Deezer.

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

Chart > Albums: Get Deezer catalog information for the top albums on Deezer.

Parameters:

limitint; keyword-only; optional

Maximum number of albums to return.

Minimum value: 1.

API default: 10.

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 top albums.

Sample response

{
  "data": [
    {
      "artist": {
        "id": <int>,
        "link": <str>,
        "name": <str>,
        "picture": <str>,
        "picture_big": <str>,
        "picture_medium": <str>,
        "picture_small": <str>,
        "picture_xl": <str>,
        "radio": <bool>,
        "tracklist": <str>,
        "type": "artist"
      },
      "cover": <str>,
      "cover_big": <str>,
      "cover_medium": <str>,
      "cover_small": <str>,
      "cover_xl": <str>,
      "explicit_lyrics": <bool>,
      "id": <int>,
      "link": <str>,
      "md5_image": <str>,
      "position": <int>,
      "record_type": <str>,
      "title": <str>,
      "tracklist": <str>,
      "type": "album"
    }
  ],
  "prev": <str>,
  "next": <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_top_playlists(*, limit: int | None = None, offset: int | None = None) → dict[str, Any][source]¶

Chart > Playlists: Get Deezer catalog information for the top playlists on Deezer.

Parameters:

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 top playlists.

Sample response

{
  "data": [
    {
      "add_date": <str>,
      "checksum": <str>,
      "creation_date": <str>,
      "id": <int>,
      "link": <str>,
      "md5_image": <str>,
      "mod_date": <str>,
      "nb_tracks": <int>,
      "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_top_podcasts(*, limit: int | None = None, offset: int | None = None) → dict[str, Any][source]¶

Chart > Podcasts: Get Deezer catalog information for the top podcasts on Deezer.

Parameters:

limitint; keyword-only; optional

Maximum number of podcasts to return.

Minimum value: 1.

API default: 10.

offsetint; keyword-only; optional

Index of the first podcast to return. Use with limit to get the next batch of podcasts.

Minimum value: 0.

API default: 0.

Returns:

podcastsdict[str, Any]

Page of Deezer metadata for the top podcasts.

Sample response

{
  "data": [
    {
      "available": <bool>,
      "description": <str>,
      "fans": <int>,
      "id": <int>,
      "link": <str>,
      "picture": <str>,
      "picture_big": <str>,
      "picture_medium": <str>,
      "picture_small": <str>,
      "picture_xl": <str>,
      "share": <str>,
      "title": <str>
      "type": "podcast"
    }
  ],
  "prev": <str>,
  "next": <str>,
  "total": <int>
}

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

Radio > Top: Get Deezer catalog information for the top radios on Deezer.

Parameters:

limitint; keyword-only; optional

Maximum number of radios to return.

Minimum value: 1.

API default: 25.

offsetint; keyword-only; optional

Index of the first radio to return. Use with limit to get the next batch of radios.

Minimum value: 0.

API default: 0.

Returns:

radiosdict[str, Any]: Page of Deezer metadata for the top radios.

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

Chart > Tracks: Get Deezer catalog information for the top tracks on Deezer.

Parameters:

limitint; keyword-only; optional

Maximum number of tracks to return.

Minimum value: 1.

API default: 10.

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 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>,
        "link": <str>,
        "name": <str>,
        "picture": <str>,
        "picture_big": <str>,
        "picture_medium": <str>,
        "picture_small": <str>,
        "picture_xl": <str>,
        "radio": <bool>,
        "tracklist": <str>,
        "type": "artist"
      },
      "duration": <int>,
      "explicit_content_cover": <int>,
      "explicit_content_lyrics": <int>,
      "explicit_lyrics": <bool>,
      "id": <int>,
      "link": <str>,
      "md5_image": <str>,
      "position": <int>,
      "preview": <str>,
      "rank": <int>,
      "title": <str>,
      "title_short": <str>,
      "title_version": <str>,
      "type": "track"
    }
  ],
  "prev": <str>,
  "next": <str>,
  "total": <int>
}