PodcastsAPI¶

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

Bases: DeezerResourceAPI

Podcasts 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_podcast`	User > Podcasts: Favorite a podcast.
`get_podcast`	Podcast: Get Deezer catalog information for a podcast.
`get_podcast_episodes`	Podcast > Episodes: Get Deezer catalog information for episodes in a podcast.
`get_top_podcasts`	Chart > Podcasts: Get Deezer catalog information for the top podcasts on Deezer.
`get_user_followed_podcasts`	User > Podcasts: Get Deezer catalog information for a user's favorite podcasts.
`unfollow_podcast`	User > Podcasts: Unfavorite a podcast.

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

User > Podcasts: Favorite a podcast.

Permission

Required

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

Parameters:

podcast_idint or str; positional-only

Deezer ID of the podcast.

Examples: 436862, "2740882".

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 podcast was favorited successfully.

get_podcast(podcast_id: int | str, /) → dict[str, Any][source]¶

Podcast: Get Deezer catalog information for a podcast.

Parameters:

podcast_idint or str; positional-only

Deezer ID of the podcast.

Examples: 436862, "2740882".

Returns:

podcastdict[str, Any]

Deezer metadata for the podcast.

Sample response

{
  "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"
}

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

Podcast > Episodes: Get Deezer catalog information for episodes in a podcast.

Parameters:

podcast_idint or str; positional-only

Deezer ID of the podcast.

Examples: 436862, "2740882".

limitint; keyword-only; optional

Maximum number of episodes to return.

Minimum value: 1.

API default: 25.

offsetint; keyword-only; optional

Index of the first episode to return. Use with limit to get the next batch of episodes.

Minimum value: 0.

API default: 0.

Returns:

episodesdict[str, Any]

Page of Deezer metadata for the podcast’s episodes.

Sample response

{
  "data": [
    {
      "duration": <int>,
      "id": <int>,
      "picture": <str>,
      "release_date": <str>,
      "title": <str>,
      "type": "episode"
    }
  ],
  "next": <str>,
  "prev": <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_user_followed_podcasts(user_id: int | str = 'me', /, *, limit: int | None = None, offset: int | None = None) → dict[str, Any][source]¶

User > Podcasts: Get Deezer catalog information for a user’s favorite podcasts.

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 podcasts to return.

Minimum value: 1.

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 user’s favorite podcasts.

Sample response

{
  "checksum": <str>,
  "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>,
      "time_add": <int>,
      "title": <str>,
      "type": "podcast"
    }
  ],
  "next": <str>,
  "prev": <str>,
  "total": <int>
}

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

User > Podcasts: Unfavorite a podcast.

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:

podcast_idint or str; positional-only

Deezer ID of the podcast.

Examples: 436862, "2740882".

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 podcast was unfavorited successfully.