EpisodesAPI¶

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

Bases: DeezerResourceAPI

Episodes 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_episode`	Episode: Get Deezer catalog information for a podcast episode.
`remove_episode_resume_point`	Episode > Bookmark: Remove a resume point for a podcast episode.
`set_episode_resume_point`	Episode > Bookmark: Set a resume point for a podcast episode.

get_episode(episode_id: int | str, /) → dict[str, Any][source]¶

Episode: Get Deezer catalog information for a podcast episode.

Parameters:

episode_idint or str; positional-only

Deezer ID of the episode.

Examples: 796445891, "822265072".

Returns:

episodedict[str, Any]

Deezer metadata for the podcast episode.

Sample response

{
  "available": <bool>,
  "description": <str>,
  "duration": <int>,
  "id": <int>,
  "link": <str>,
  "picture": <str>,
  "picture_big": <str>,
  "picture_medium": <str>,
  "picture_small": <str>,
  "picture_xl": <str>,
  "podcast": {
    "id": <int>,
    "link": <str>,
    "picture": <str>,
    "picture_big": <str>,
    "picture_medium": <str>,
    "picture_small": <str>,
    "picture_xl": <str>,
    "title": <str>,
    "type": "podcast"
  },
  "release_date": <str>,
  "share": <str>,
  "title": <str>,
  "track_token": <str>,
  "type": "episode"
}

remove_episode_resume_point(episode_id: int | str, /) → dict[str, Any][source]¶

Episode > Bookmark: Remove a resume point for a podcast episode.

Permission

Required

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

Parameters:

episode_idint or str; positional-only

Deezer ID of the episode.

Example: 796445891, "822265072".

Returns:

statusdict[str, Any]

Whether the resume point was removed successfully.

Sample response: {'error': [], 'results': True}.

set_episode_resume_point(episode_id: int | str, /, position: int) → dict[str, Any][source]¶

Episode > Bookmark: Set a resume point for a podcast episode.

Permission

Required

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

Parameters:

episode_idint or str; positional-only

Deezer ID of the episode.

Example: 796445891, "822265072".

positionint

Playback position within the episode as a percentage.

Valid range: 0 to 100.

Returns:

statusdict[str, Any]

Whether the resume point was set successfully.

Sample response: {'error': [], 'results': True}.