Web APIReferences / Audiobooks / Get Audiobook Chapters

Get Audiobook Chapters

Get Spotify catalog information about an audiobook's chapters. Audiobooks are only available within the US, UK, Canada, Ireland, New Zealand and Australia markets.

Important policy notes

Request

  • idstring
    Required

    The Spotify ID for the audiobook.

    Example: 7iHfbu1YPACw6oZPAFJtqe
  • marketstring

    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.

    Example: market=ES
  • limitinteger

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

    Default: limit=20Range: 0 - 50Example: limit=10
  • offsetinteger

    The index of the first item to return. Default: 0 (the first item). Use with limit to get the next set of items.

    Default: offset=0Example: offset=5

Response

Pages of chapters

  • hrefstring
    Required

    A link to the Web API endpoint returning the full result of the request

    Example: "https://api.spotify.com/v1/me/shows?offset=0&limit=20"
  • limitinteger
    Required

    The maximum number of items in the response (as set in the query or by default).

    Example: 20
  • nextstring
    Required
    Nullable

    URL to the next page of items. ( null if none)

    Example: "https://api.spotify.com/v1/me/shows?offset=1&limit=1"
  • offsetinteger
    Required

    The offset of the items returned (as set in the query or by default)

    Example: 0
  • previousstring
    Required
    Nullable

    URL to the previous page of items. ( null if none)

    Example: "https://api.spotify.com/v1/me/shows?offset=1&limit=1"
  • totalinteger
    Required

    The total number of items available to return.

    Example: 4
  • Required
    • audio_preview_urlstring
      Required
      Nullable
      Deprecated

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

      Important policy note
      Example: "https://p.scdn.co/mp3-preview/2f37da1d4221f40b9d1a98cd191f4d6f1646ad17"
    • available_marketsarray of strings
      Deprecated

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

    • chapter_numberinteger
      Required

      The number of the chapter

      Example: 1
    • descriptionstring
      Required

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

      Example: "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."
    • html_descriptionstring
      Required

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

      Example: "<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>"
    • duration_msinteger
      Required

      The chapter length in milliseconds.

      Example: 1686230
    • explicitboolean
      Required

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

    • Required

      External URLs for this chapter.

    • hrefstring
      Required

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

      Example: "https://api.spotify.com/v1/episodes/5Xt5DXGzch68nYYamXrNxZ"
    • idstring
      Required

      The Spotify ID for the chapter.

      Example: "5Xt5DXGzch68nYYamXrNxZ"
    • Required

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

      • urlstring
        Required

        The source URL of the image.

        Example: "https://i.scdn.co/image/ab67616d00001e02ff9ca10b55ce82ae553c8228"
      • heightinteger
        Required
        Nullable

        The image height in pixels.

        Example: 300
      • widthinteger
        Required
        Nullable

        The image width in pixels.

        Example: 300
    • is_playableboolean
      Required

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

    • languagesarray of strings
      Required

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

      Example: ["fr","en"]
    • namestring
      Required

      The name of the chapter.

      Example: "Starting Your Own Podcast: Tips, Tricks, and Advice From Anchor Creators"
    • release_datestring
      Required

      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".

      Example: "1981-12-15"
    • release_date_precisionstring
      Required

      The precision with which release_date value is known.

      Allowed values: "year", "month", "day"Example: "day"
    • 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'.

      • fully_playedboolean

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

      • resume_position_msinteger

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

    • typestring
      Required

      The object type.

      Allowed values: "episode"
    • uristring
      Required

      The Spotify URI for the chapter.

      Example: "spotify:episode:0zLhl3WsOCQHbe1BPTiHgr"
    • Included in the response when a content restriction is applied.

      • reasonstring

        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.

endpointhttps://api.spotify.com/v1/audiobooks/{id}/chaptersidmarketlimitoffset

Response sample

{  "href": "https://api.spotify.com/v1/me/shows?offset=0&limit=20",  "limit": 20,  "next": "https://api.spotify.com/v1/me/shows?offset=1&limit=1",  "offset": 0,  "previous": "https://api.spotify.com/v1/me/shows?offset=1&limit=1",  "total": 4,  "items": [    {      "audio_preview_url": "https://p.scdn.co/mp3-preview/2f37da1d4221f40b9d1a98cd191f4d6f1646ad17",      "available_markets": ["string"],      "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.",      "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>",      "duration_ms": 1686230,      "explicit": false,      "external_urls": {        "spotify": "string"      },      "href": "https://api.spotify.com/v1/episodes/5Xt5DXGzch68nYYamXrNxZ",      "id": "5Xt5DXGzch68nYYamXrNxZ",      "images": [        {          "url": "https://i.scdn.co/image/ab67616d00001e02ff9ca10b55ce82ae553c8228",          "height": 300,          "width": 300        }      ],      "is_playable": false,      "languages": ["fr", "en"],      "name": "Starting Your Own Podcast: Tips, Tricks, and Advice From Anchor Creators",      "release_date": "1981-12-15",      "release_date_precision": "day",      "resume_point": {        "fully_played": false,        "resume_position_ms": 0      },      "type": "episode",      "uri": "spotify:episode:0zLhl3WsOCQHbe1BPTiHgr",      "restrictions": {        "reason": "string"      }    }  ]}