Skip to content

Shows

API #

Implementation to make API calls with.

Parameters:

get_show #

get_show(show_id: str, *, market: MissingOr[str] = MISSING) -> Show

Get Spotify catalog information for a single show.

Parameters:

Returns:

  • Show –

    The requested show.

get_several_shows #

get_several_shows(show_ids: list[str], *, market: MissingOr[str] = MISSING) -> list[SimpleShow]

Get Spotify catalog information for several shows.

Parameters:

Returns:

get_show_episodes #

get_show_episodes(show_id: str, *, limit: MissingOr[int] = MISSING, offset: MissingOr[int] = MISSING, market: MissingOr[str] = MISSING) -> Paginator[SimpleEpisode]

Get Spotify catalog information about a shows's episodes.

Parameters:

  • show_id (str) –

    The ID of the show.

  • limit (int, default: 20 ) –

    The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.

  • offset (int, default: 0 ) –

    The index of the first item to return. Default: 0 (the first item).

  • market (str, default: MISSING ) –

    Only get content available in that market. Must be an ISO 3166-1 alpha-2 country code.

Returns:

get_users_saved_shows #

get_users_saved_shows(*, limit: MissingOr[int] = MISSING, offset: MissingOr[int] = MISSING) -> Paginator[SavedShow]

Get a list of the shows saved in the current user's 'Your Music' library.

Required Authorization Scope

USER_LIBRARY_READ

Parameters:

  • limit (int, default: 20 ) –

    The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.

  • offset (int, default: 0 ) –

    The index of the first item to return. Default: 0 (the first item).

Returns:

remove_users_saved_shows #

remove_users_saved_shows(show_ids: list[str], *, market: MissingOr[str] = MISSING) -> None

Remove one or more shows from the current user's 'Your Music' library.

Required Authorization Scope

USER_LIBRARY_MODIFY

Parameters:

check_users_saved_shows #

check_users_saved_shows(show_ids: list[str]) -> list[bool]

Check if one or more shows is already saved in the current user's 'Your Music' library.

Required Authorization Scope

USER_LIBRARY_READ

Parameters:

  • show_ids (list[str]) –

    The IDs of the shows. Maximum: 50.

Returns:

  • list[bool] –

    A list of booleans dictating whether or not the corresponding shows are already saved.

SimpleShow #

A simplified show.

available_markets #

available_markets: list[str]

A list of the countries in which the show can be played, identified by their ISO 3166-1 alpha-2 code.

copyrights #

copyrights: list[Copyright]

The copyright statements of the show.

description #

description: str

A description of the show. HTML tags are stripped away from this field, use the html_description field in case HTML tags are needed.

html_description #

html_description: str

A description of the show. This field may contain HTML tags.

explicit #

explicit: bool

Whether or not the show has explicit content.

external_urls #

external_urls: ExternalURLs

External URLs for the show.

href #

href: str

A link to the Web API endpoint providing full details of the show.

id #

id: str

The Spotify ID for the show.

images #

images: list[Image]

The cover art for the show in various sizes, widest first.

is_externally_hosted #

is_externally_hosted: bool | None

True if all of the shows episodes are hosted outside of Spotify's CDN. This field might be None in some cases.

languages #

languages: list[str]

A list of the languages used in the show, identified by their ISO 639 code.

media_type #

media_type: str

The media type of the show.

name #

name: str

The name of the episode.

publisher #

publisher: str

The publisher of the show.

uri #

uri: str

The Spotify URI for the show.

total_episodes #

total_episodes: int

The total number of episodes in the show.

Show #

A show.

available_markets #

available_markets: list[str]

A list of the countries in which the show can be played, identified by their ISO 3166-1 alpha-2 code.

copyrights #

copyrights: list[Copyright]

The copyright statements of the show.

description #

description: str

A description of the show. HTML tags are stripped away from this field, use the html_description field in case HTML tags are needed.

html_description #

html_description: str

A description of the show. This field may contain HTML tags.

explicit #

explicit: bool

Whether or not the show has explicit content.

external_urls #

external_urls: ExternalURLs

External URLs for the show.

href #

href: str

A link to the Web API endpoint providing full details of the show.

id #

id: str

The Spotify ID for the show.

images #

images: list[Image]

The cover art for the show in various sizes, widest first.

is_externally_hosted #

is_externally_hosted: bool | None

True if all of the shows episodes are hosted outside of Spotify's CDN. This field might be None in some cases.

languages #

languages: list[str]

A list of the languages used in the show, identified by their ISO 639 code.

media_type #

media_type: str

The media type of the show.

name #

name: str

The name of the episode.

publisher #

publisher: str

The publisher of the show.

uri #

uri: str

The Spotify URI for the show.

total_episodes #

total_episodes: int

The total number of episodes in the show.

episodes #

episodes: Paginator[SimpleEpisode]

The episodes of the show.

SavedShow #

Information about a show saved to a user's 'Your Music' library.

added_at #

added_at: datetime

The date and time the show was saved.

show #

show: SimpleShow

The show.