Chapters

Note

Audiobooks are only available for the US, UK, Ireland, New Zealand and Australia markets.

API #

Implementation to make API calls with.

Parameters:

access_flow (AuthorizationCodeFlow | ClientCredentialsFlow) –

Access flow to use for api requests.

get_chapter #

get_chapter(chapter_id: str, *, market: MissingOr[str] = MISSING) -> Chapter

Get Spotify catalog information for a single chapter.

Parameters:

chapter_id (str) –

The ID of the chapter.
market (str, default: MISSING ) –

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

Returns:

Chapter –

The requested chapter.

get_several_chapters #

get_several_chapters(chapter_ids: list[str], *, market: MissingOr[str] = MISSING) -> list[Chapter]

Get Spotify catalog information for several chapters.

Parameters:

chapter_ids (list[str]) –

The IDs of the chapters. Maximum: 50.
market (str, default: MISSING ) –

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

Returns:

list[Chapter] –

The requested chapters.

SimpleChapter #

A simplified chapter.

audio_preview_url #

audio_preview_url: str | None

A URL to a 30 second preview (MP3 format) of the chapter. None if not available.

available_markets #

available_markets: list[str] | None

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

chapter_number #

chapter_number: int

The number of the chapter.

description #

description: str

A description of the chapter. 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 chapter. This field may contain HTML tags.

duration #

duration: timedelta = Field(alias='duration_ms')

The chapter length.

explicit #

explicit: bool

Whether or not the chapter has explicit content.

external_urls #

external_urls: ExternalURLs

External URLs for the chapter.

href #

href: str

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

id #

id: str

The Spotify ID for the chapter.

images #

images: list[Image]

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

is_playable #

is_playable: bool | None = None

True if the chapter is playable in the given market. Otherwise False.

languages #

languages: list[str]

A list of the languages used in the chapter, identified by their ISO 639-1 code.

name #

name: str

The name of the chapter.

release_date #

release_date: date | None

The date the chapter was first released.

release_date_precision #

release_date_precision: ReleaseDatePrecision

The precision with which release_date value is known.

resume_point #

resume_point: ResumePoint | None

The user's most recent position in the chapter.

Required Authorization Scope

USER_READ_PLAYBACK_POSITION.

uri #

uri: str

The Spotify URI for the chapter.

restrictions #

restrictions: Restrictions | None = None

Present when a content restriction is applied.

Chapter #

A chapter.

audio_preview_url #

audio_preview_url: str | None

A URL to a 30 second preview (MP3 format) of the chapter. None if not available.

available_markets #

available_markets: list[str] | None

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

chapter_number #

chapter_number: int

The number of the chapter.

description #

description: str

A description of the chapter. 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 chapter. This field may contain HTML tags.

duration #

duration: timedelta = Field(alias='duration_ms')

The chapter length.

explicit #

explicit: bool

Whether or not the chapter has explicit content.

external_urls #

external_urls: ExternalURLs

External URLs for the chapter.

href #

href: str

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

id #

id: str

The Spotify ID for the chapter.

images #

images: list[Image]

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

is_playable #

is_playable: bool | None = None

True if the chapter is playable in the given market. Otherwise False.

languages #

languages: list[str]

A list of the languages used in the chapter, identified by their ISO 639-1 code.

name #

name: str

The name of the chapter.

release_date #

release_date: date | None

The date the chapter was first released.

release_date_precision #

release_date_precision: ReleaseDatePrecision

The precision with which release_date value is known.

resume_point #

resume_point: ResumePoint | None

The user's most recent position in the chapter.

Required Authorization Scope

USER_READ_PLAYBACK_POSITION.

uri #

uri: str

The Spotify URI for the chapter.

restrictions #

restrictions: Restrictions | None = None

Present when a content restriction is applied.

audiobook #

audiobook: SimpleAudiobook

The audiobook on which the chapter appears.