Audiobooks
Note
Audiobooks are only available for the US, UK, Ireland, New Zealand and Australia markets.
Implementation to make API calls with.
Parameters:
-
access_flow(AuthorizationCodeFlow | ClientCredentialsFlow) –Access flow to use for api requests.
Get Spotify catalog information for a single audiobook.
Parameters:
-
audiobook_id(str) –The ID of the audiobook.
-
market(str, default:MISSING) –Only get content available in that market. Must be an ISO 3166-1 alpha-2 country code.
Returns:
-
Audiobook–The requested audiobook.
get_several_audiobooks(audiobook_ids: list[str], *, market: MissingOr[str] = MISSING) -> list[Audiobook]
Get Spotify catalog information for several audiobooks.
Parameters:
-
audiobook_ids(list[str]) –The IDs of the audiobooks. Maximum: 50.
-
market(str, default:MISSING) –Only get content available in that market. Must be an ISO 3166-1 alpha-2 country code.
Returns:
get_audiobook_chapters(audiobook_id: str, *, limit: MissingOr[int] = MISSING, offset: MissingOr[int] = MISSING, market: MissingOr[str] = MISSING) -> Paginator[SimpleChapter]
Get Spotify catalog information about an audiobooks's chapters.
Parameters:
-
audiobook_id(str) –The ID of the audiobook.
-
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:
-
Paginator[SimpleChapter]–A paginator who's items are a list of chapters.
get_users_saved_audiobooks(*, limit: MissingOr[int] = MISSING, offset: MissingOr[int] = MISSING) -> Paginator[SimpleAudiobook]
Get a list of the audiobooks saved in the current user's 'Your Music' library.
Required Authorization Scope
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:
-
Paginator[SimpleAudiobook]–A paginator who's items are a list of audiobooks.
Save one or more audiobooks to the current user's 'Your Music' library.
Required Authorization Scope
Parameters:
Remove one or more audiobooks from the current user's 'Your Music' library.
Required Authorization Scope
Parameters:
Check if one or more audiobooks are already saved in the current user's 'Your Music' library.
Required Authorization Scope
Parameters:
Returns:
A simplified audiobook.
A list of the countries in which the audiobook can be played, identified by their ISO 3166-1 alpha-2 code.
description: str
A description of the audiobook. HTML tags are stripped away from this field, use the html_description field in case HTML tags are needed.
html_description: str
A description of the audiobook. This field may contain HTML tags.
A list of the languages used in the audiobook, identified by their ISO 639 code.
An audiobook.
A list of the countries in which the audiobook can be played, identified by their ISO 3166-1 alpha-2 code.
description: str
A description of the audiobook. HTML tags are stripped away from this field, use the html_description field in case HTML tags are needed.
html_description: str
A description of the audiobook. This field may contain HTML tags.
A list of the languages used in the audiobook, identified by their ISO 639 code.