Skip to content
DocumentationAPI Reference

Get a Chapter

ChapterRetrieveResponse chapters().retrieve(ChapterRetrieveParamsparams = ChapterRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/chapters/{id}

Get Spotify catalog information for a single audiobook chapter. Chapters are only available within the US, UK, Canada, Ireland, New Zealand and Australia markets.

ParametersExpand Collapse
ChapterRetrieveParams params
Optional<String> id

The Spotify ID for the chapter.

Optional<String> market

An ISO 3166-1 alpha-2 country code. If a country code is specified, only content that is available in that market will be returned.
If a valid user access token is specified in the request header, the country associated with the user account will take priority over this parameter.
Note: If neither market or user country are provided, the content is considered unavailable for the client.
Users can view the country that is associated with their account in the account settings.

ReturnsExpand Collapse
class ChapterRetrieveResponse:
String id

The Spotify ID for the chapter.

DeprecatedOptional<String> audioPreviewUrl

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

AudiobookBase audiobook

The audiobook for which the chapter belongs.

String id

The Spotify ID for the audiobook.

List<AuthorObject> authors

The author(s) for the audiobook.

Optional<String> name

The name of the author.

Optional<Boolean> published

The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists

List<String> availableMarkets

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

List<CopyrightObject> copyrights

The copyright statements of the audiobook.

The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists

The copyright text for this content.

The type of copyright: C = the copyright, P = the sound recording (performance) copyright.

String description

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

boolean explicit

Whether or not the audiobook has explicit content (true = yes it does; false = no it does not OR unknown).

ExternalUrlObject externalUrls

External URLs for this audiobook.

Optional<Boolean> published

The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists

Optional<String> spotify

The Spotify URL for the object.

String href

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

String htmlDescription

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

List<ImageObject> images

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

Optional<Long> height

The image height in pixels.

String url

The source URL of the image.

Optional<Long> width

The image width in pixels.

Optional<Boolean> published

The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists

List<String> languages

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

String mediaType

The media type of the audiobook.

String name

The name of the audiobook.

List<NarratorObject> narrators

The narrator(s) for the audiobook.

Optional<String> name

The name of the Narrator.

Optional<Boolean> published

The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists

String publisher

The publisher of the audiobook.

long totalChapters

The number of chapters in this audiobook.

JsonValue; type "audiobook"constant"audiobook"constant

The object type.

String uri

The Spotify URI for the audiobook.

Optional<String> edition

The edition of the audiobook.

Optional<Boolean> published

The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists

long chapterNumber

The number of the chapter

String description

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

long durationMs

The chapter length in milliseconds.

boolean explicit

Whether or not the chapter has explicit content (true = yes it does; false = no it does not OR unknown).

ExternalUrlObject externalUrls

External URLs for this chapter.

Optional<Boolean> published

The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists

Optional<String> spotify

The Spotify URL for the object.

String href

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

String htmlDescription

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

List<ImageObject> images

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

Optional<Long> height

The image height in pixels.

String url

The source URL of the image.

Optional<Long> width

The image width in pixels.

Optional<Boolean> published

The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists

boolean isPlayable

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

List<String> languages

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

String name

The name of the chapter.

String releaseDate

The date the chapter was first released, for example "1981-12-15". Depending on the precision, it might be shown as "1981" or "1981-12".

ReleaseDatePrecision releaseDatePrecision

The precision with which release_date value is known.

Accepts one of the following:
YEAR("year")
MONTH("month")
DAY("day")
JsonValue; type "episode"constant"episode"constant

The object type.

String uri

The Spotify URI for the chapter.

Optional<List<String>> availableMarkets

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

Optional<Boolean> published

The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists

Optional<ChapterRestrictionObject> restrictions

Included in the response when a content restriction is applied.

Optional<Boolean> published

The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists

Optional<String> reason

The reason for the restriction. Supported values:

  • market - The content item is not available in the given market.
  • product - The content item is not available for the user's subscription type.
  • explicit - The content item is explicit and the user's account is set to not play explicit content.
  • payment_required - Payment is required to play the content item.

Additional reasons may be added in the future. Note: If you use this field, make sure that your application safely handles unknown values.

Optional<ResumePointObject> resumePoint

The user's most recent position in the chapter. Set if the supplied access token is a user token and has the scope 'user-read-playback-position'.

Optional<Boolean> fullyPlayed

Whether or not the episode has been fully played by the user.

Optional<Boolean> published

The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists

Optional<Long> resumePositionMs

The user's most recent position in the episode in milliseconds.

Get a Chapter

package dev.cjav.spotted.example;

import dev.cjav.spotted.client.SpottedClient;
import dev.cjav.spotted.client.okhttp.SpottedOkHttpClient;
import dev.cjav.spotted.models.chapters.ChapterRetrieveParams;
import dev.cjav.spotted.models.chapters.ChapterRetrieveResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        SpottedClient client = SpottedOkHttpClient.fromEnv();

        ChapterRetrieveResponse chapter = client.chapters().retrieve("0D5wENdkdwbqlrHoaJ9g29");
    }
}
{
  "id": "5Xt5DXGzch68nYYamXrNxZ",
  "audio_preview_url": "https://p.scdn.co/mp3-preview/2f37da1d4221f40b9d1a98cd191f4d6f1646ad17",
  "audiobook": {
    "id": "id",
    "authors": [
      {
        "name": "name",
        "published": true
      }
    ],
    "available_markets": [
      "string"
    ],
    "copyrights": [
      {
        "published": true,
        "text": "text",
        "type": "type"
      }
    ],
    "description": "description",
    "explicit": true,
    "external_urls": {
      "published": true,
      "spotify": "spotify"
    },
    "href": "href",
    "html_description": "html_description",
    "images": [
      {
        "height": 300,
        "url": "https://i.scdn.co/image/ab67616d00001e02ff9ca10b55ce82ae553c8228\n",
        "width": 300,
        "published": true
      }
    ],
    "languages": [
      "string"
    ],
    "media_type": "media_type",
    "name": "name",
    "narrators": [
      {
        "name": "name",
        "published": true
      }
    ],
    "publisher": "publisher",
    "total_chapters": 0,
    "type": "audiobook",
    "uri": "uri",
    "edition": "Unabridged",
    "published": true
  },
  "chapter_number": 1,
  "description": "We kept on ascending, with occasional periods of quick descent, but in the main always ascending. Suddenly, I became conscious of the fact that the driver was in the act of pulling up the horses in the courtyard of a vast ruined castle, from whose tall black windows came no ray of light, and whose broken battlements showed a jagged line against the moonlit sky.\n",
  "duration_ms": 1686230,
  "explicit": true,
  "external_urls": {
    "published": true,
    "spotify": "spotify"
  },
  "href": "https://api.spotify.com/v1/episodes/5Xt5DXGzch68nYYamXrNxZ",
  "html_description": "<p>We kept on ascending, with occasional periods of quick descent, but in the main always ascending. Suddenly, I became conscious of the fact that the driver was in the act of pulling up the horses in the courtyard of a vast ruined castle, from whose tall black windows came no ray of light, and whose broken battlements showed a jagged line against the moonlit sky.</p>\n",
  "images": [
    {
      "height": 300,
      "url": "https://i.scdn.co/image/ab67616d00001e02ff9ca10b55ce82ae553c8228\n",
      "width": 300,
      "published": true
    }
  ],
  "is_playable": true,
  "languages": [
    "fr",
    "en"
  ],
  "name": "Starting Your Own Podcast: Tips, Tricks, and Advice From Anchor Creators\n",
  "release_date": "1981-12-15",
  "release_date_precision": "day",
  "type": "episode",
  "uri": "spotify:episode:0zLhl3WsOCQHbe1BPTiHgr",
  "available_markets": [
    "string"
  ],
  "published": true,
  "restrictions": {
    "published": true,
    "reason": "reason"
  },
  "resume_point": {
    "fully_played": true,
    "published": true,
    "resume_position_ms": 0
  }
}
Returns Examples
{
  "id": "5Xt5DXGzch68nYYamXrNxZ",
  "audio_preview_url": "https://p.scdn.co/mp3-preview/2f37da1d4221f40b9d1a98cd191f4d6f1646ad17",
  "audiobook": {
    "id": "id",
    "authors": [
      {
        "name": "name",
        "published": true
      }
    ],
    "available_markets": [
      "string"
    ],
    "copyrights": [
      {
        "published": true,
        "text": "text",
        "type": "type"
      }
    ],
    "description": "description",
    "explicit": true,
    "external_urls": {
      "published": true,
      "spotify": "spotify"
    },
    "href": "href",
    "html_description": "html_description",
    "images": [
      {
        "height": 300,
        "url": "https://i.scdn.co/image/ab67616d00001e02ff9ca10b55ce82ae553c8228\n",
        "width": 300,
        "published": true
      }
    ],
    "languages": [
      "string"
    ],
    "media_type": "media_type",
    "name": "name",
    "narrators": [
      {
        "name": "name",
        "published": true
      }
    ],
    "publisher": "publisher",
    "total_chapters": 0,
    "type": "audiobook",
    "uri": "uri",
    "edition": "Unabridged",
    "published": true
  },
  "chapter_number": 1,
  "description": "We kept on ascending, with occasional periods of quick descent, but in the main always ascending. Suddenly, I became conscious of the fact that the driver was in the act of pulling up the horses in the courtyard of a vast ruined castle, from whose tall black windows came no ray of light, and whose broken battlements showed a jagged line against the moonlit sky.\n",
  "duration_ms": 1686230,
  "explicit": true,
  "external_urls": {
    "published": true,
    "spotify": "spotify"
  },
  "href": "https://api.spotify.com/v1/episodes/5Xt5DXGzch68nYYamXrNxZ",
  "html_description": "<p>We kept on ascending, with occasional periods of quick descent, but in the main always ascending. Suddenly, I became conscious of the fact that the driver was in the act of pulling up the horses in the courtyard of a vast ruined castle, from whose tall black windows came no ray of light, and whose broken battlements showed a jagged line against the moonlit sky.</p>\n",
  "images": [
    {
      "height": 300,
      "url": "https://i.scdn.co/image/ab67616d00001e02ff9ca10b55ce82ae553c8228\n",
      "width": 300,
      "published": true
    }
  ],
  "is_playable": true,
  "languages": [
    "fr",
    "en"
  ],
  "name": "Starting Your Own Podcast: Tips, Tricks, and Advice From Anchor Creators\n",
  "release_date": "1981-12-15",
  "release_date_precision": "day",
  "type": "episode",
  "uri": "spotify:episode:0zLhl3WsOCQHbe1BPTiHgr",
  "available_markets": [
    "string"
  ],
  "published": true,
  "restrictions": {
    "published": true,
    "reason": "reason"
  },
  "resume_point": {
    "fully_played": true,
    "published": true,
    "resume_position_ms": 0
  }
}