EditorialAPI¶

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

Bases: DeezerResourceAPI

Editorial 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_editorial`	Editorial: Get Deezer catalog information for an editorial or all available editorials.
`get_editorial_albums`	Editorial > Selection: Get Deezer catalog information for featured albums selected by the Deezer team.
`get_editorial_charts`	Editorial > Charts: Get Deezer catalog information for the top editorial albums, artists, playlists and tracks.
`get_editorial_releases`	Editorial > Releases: Get Deezer catalog information for new releases selected by the Deezer team.

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

Editorial: Get Deezer catalog information for an editorial or all available editorials.

Parameters:

editorial_idint, str, or None; positional-only; optional

Deezer ID of the editorial. If None, all available editorials are returned.

Examples: 0, "2".

limitint; keyword-only; optional

Maximum number of editorials to return. Only applicable when editorial_id is None.

Minimum value: 1.

offsetint; keyword-only; optional

Index of the first editorial to return. Use with limit to get the next batch of editorials. Only applicable when editorial_id is None.

Minimum value: 0.

API default: 0.

Returns:

editorialdict[str, Any]

Deezer metadata for the specified editorial or a page of Deezer metadata for all available editorials.

Sample response

Single editorial

{
  "id": <int>,
  "name": <str>,
  "picture": <str>,
  "picture_big": <str>,
  "picture_medium": <str>,
  "picture_small": <str>,
  "picture_xl": <str>,
  "type": "editorial"
}

Available editorials

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

get_editorial_albums(editorial_id: int | str = 0, /) → dict[str, Any][source]¶

Editorial > Selection: Get Deezer catalog information for featured albums selected by the Deezer team.

Parameters:

editorial_idint or str; positional-only; default: 0

Deezer ID of the editorial.

Examples: 0, "2".

Returns:

albumsdict[str, Any]

Deezer metadata for the featured albums.

Sample response

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

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

Editorial > Charts: Get Deezer catalog information for the top editorial albums, artists, playlists and tracks.

Parameters:

editorial_idint or str; positional-only; default: 0

Deezer ID of the editorial.

Examples: 0, "2".

limitint; keyword-only; optional

Maximum number of items to return per item type.

Minimum value: 1.

API default: 10.

offsetint; keyword-only; optional

Index of the first item to return per item type. Use with limit to get the next batch of items.

Minimum value: 0.

API default: 0.

Returns:

chartsdict[str, Any]

Deezer metadata for the top editorial items.

Sample response

{
  "albums": {
    "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"
      }
    ],
    "total": <int>
  },
  "artists": {
    "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"
      }
    ],
    "total": <int>
  },
  "playlists": {
    "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"
        }
      }
    ],
    "total": <int>
  },
  "podcasts": {
    "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"
      }
    ],
    "total": <int>
  },
  "tracks": {
    "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"
      }
    ],
    "total": <int>
  }
}

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

Editorial > Releases: Get Deezer catalog information for new releases selected by the Deezer team.

Parameters:

editorial_idint or str; positional-only; default: 0

Deezer ID of the editorial.

Examples: 0, "2".

limitint; keyword-only; optional

Maximum number of releases to return.

Minimum value: 1.

API default: 20.

offsetint; keyword-only; optional

Index of the first release to return. Use with limit to get the next batch of releases.

Minimum value: 0.

API default: 0.

Returns:

releasesdict[str, Any]

Page of Deezer metadata for the new releases.

Sample response

{
  "data": [
    {
      "artist": {
        "id": <int>,
        "name": <str>,
        "tracklist": <str>,
        "type": "artist"
      },
      "cover": <str>,
      "cover_big": <str>,
      "cover_medium": <str>,
      "cover_small": <str>,
      "cover_xl": <str>,
      "id": <int>,
      "md5_image": <str>,
      "release_date": <str>,
      "title": <str>,
      "tracklist": <str>,
      "type": "album"
    }
  ],
  "prev": <str>,
  "next": <str>,
  "total": <int>
}