Get Several Episodes

episodes.bulk_retrieve(**kwargs) -> EpisodeBulkRetrieveResponse { episodes }

GET/episodes

Get Spotify catalog information for several episodes based on their Spotify IDs.

ParametersExpand Collapse

ids: String

A comma-separated list of the Spotify IDs for the episodes. Maximum: 50 IDs.

market: String

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 EpisodeBulkRetrieveResponse { episodes }

episodes: Array[EpisodeObject { id, audio_preview_url, description, 19 more } ]

id: String

The Spotify ID for the episode.

Deprecatedaudio_preview_url: String

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

description: String

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

duration_ms: Integer

The episode length in milliseconds.

explicit: bool

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

external_urls: ExternalURLObject { published, spotify }

External URLs for this episode.

published: bool

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

spotify: String

The Spotify URL for the object.

href: String

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

html_description: String

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

images: Array[ImageObject { height, url, width, published } ]

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

height: Integer

The image height in pixels.

url: String

The source URL of the image.

width: Integer

The image width in pixels.

published: bool

is_externally_hosted: bool

True if the episode is hosted outside of Spotify's CDN.

is_playable: bool

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

languages: Array[String]

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

name: String

The name of the episode.

release_date: String

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

release_date_precision: :year | :month | :day

The precision with which release_date value is known.

Accepts one of the following:

:year

:month

:day

show: ShowBase { id, available_markets, copyrights, 15 more }

The show on which the episode belongs.

id: String

The Spotify ID for the show.

available_markets: Array[String]

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

copyrights: Array[CopyrightObject { published, text, type } ]

The copyright statements of the show.

published: bool

text: String

The copyright text for this content.

type: String

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

description: String

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

explicit: bool

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

external_urls: ExternalURLObject { published, spotify }

External URLs for this show.

published: bool

spotify: String

The Spotify URL for the object.

href: String

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

html_description: String

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

images: Array[ImageObject { height, url, width, published } ]

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

height: Integer

The image height in pixels.

url: String

The source URL of the image.

width: Integer

The image width in pixels.

published: bool

is_externally_hosted: bool

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

languages: Array[String]

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

media_type: String

The media type of the show.

name: String

The name of the episode.

publisher: String

The publisher of the show.

total_episodes: Integer

The total number of episodes in the show.

type: :show

The object type.

uri: String

The Spotify URI for the show.

published: bool

type: :episode

The object type.

uri: String

The Spotify URI for the episode.

Deprecatedlanguage: String

The language used in the episode, identified by a ISO 639 code. This field is deprecated and might be removed in the future. Please use the languages field instead.

published: bool

restrictions: EpisodeRestrictionObject { published, reason }

Included in the response when a content restriction is applied.

published: bool

reason: String

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.

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

resume_point: ResumePointObject { fully_played, published, resume_position_ms }

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

fully_played: bool

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

published: bool

resume_position_ms: Integer

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

Get Several Episodes

require "spotted"

spotted = Spotted::Client.new(access_token: "My Access Token")

response = spotted.episodes.bulk_retrieve(ids: "77o6BIVlYM3msb4MMIL1jH,0Q86acNRm6V9GYx55SXKwf")

puts(response)

{
  "episodes": [
    {
      "id": "5Xt5DXGzch68nYYamXrNxZ",
      "audio_preview_url": "https://p.scdn.co/mp3-preview/2f37da1d4221f40b9d1a98cd191f4d6f1646ad17",
      "description": "A Spotify podcast sharing fresh insights on important topics of the moment—in a way only Spotify can. You’ll hear from experts in the music, podcast and tech industries as we discover and uncover stories about our work and the world around us.\n",
      "duration_ms": 1686230,
      "explicit": true,
      "external_urls": {
        "published": true,
        "spotify": "spotify"
      },
      "href": "https://api.spotify.com/v1/episodes/5Xt5DXGzch68nYYamXrNxZ",
      "html_description": "<p>A Spotify podcast sharing fresh insights on important topics of the moment—in a way only Spotify can. You’ll hear from experts in the music, podcast and tech industries as we discover and uncover stories about our work and the world around us.</p>\n",
      "images": [
        {
          "height": 300,
          "url": "https://i.scdn.co/image/ab67616d00001e02ff9ca10b55ce82ae553c8228\n",
          "width": 300,
          "published": true
        }
      ],
      "is_externally_hosted": 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",
      "show": {
        "id": "id",
        "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
          }
        ],
        "is_externally_hosted": true,
        "languages": [
          "string"
        ],
        "media_type": "media_type",
        "name": "name",
        "publisher": "publisher",
        "total_episodes": 0,
        "type": "show",
        "uri": "uri",
        "published": true
      },
      "type": "episode",
      "uri": "spotify:episode:0zLhl3WsOCQHbe1BPTiHgr",
      "language": "en",
      "published": true,
      "restrictions": {
        "published": true,
        "reason": "reason"
      },
      "resume_point": {
        "fully_played": true,
        "published": true,
        "resume_position_ms": 0
      }
    }
  ]
}

Returns Examples

{
  "episodes": [
    {
      "id": "5Xt5DXGzch68nYYamXrNxZ",
      "audio_preview_url": "https://p.scdn.co/mp3-preview/2f37da1d4221f40b9d1a98cd191f4d6f1646ad17",
      "description": "A Spotify podcast sharing fresh insights on important topics of the moment—in a way only Spotify can. You’ll hear from experts in the music, podcast and tech industries as we discover and uncover stories about our work and the world around us.\n",
      "duration_ms": 1686230,
      "explicit": true,
      "external_urls": {
        "published": true,
        "spotify": "spotify"
      },
      "href": "https://api.spotify.com/v1/episodes/5Xt5DXGzch68nYYamXrNxZ",
      "html_description": "<p>A Spotify podcast sharing fresh insights on important topics of the moment—in a way only Spotify can. You’ll hear from experts in the music, podcast and tech industries as we discover and uncover stories about our work and the world around us.</p>\n",
      "images": [
        {
          "height": 300,
          "url": "https://i.scdn.co/image/ab67616d00001e02ff9ca10b55ce82ae553c8228\n",
          "width": 300,
          "published": true
        }
      ],
      "is_externally_hosted": 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",
      "show": {
        "id": "id",
        "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
          }
        ],
        "is_externally_hosted": true,
        "languages": [
          "string"
        ],
        "media_type": "media_type",
        "name": "name",
        "publisher": "publisher",
        "total_episodes": 0,
        "type": "show",
        "uri": "uri",
        "published": true
      },
      "type": "episode",
      "uri": "spotify:episode:0zLhl3WsOCQHbe1BPTiHgr",
      "language": "en",
      "published": true,
      "restrictions": {
        "published": true,
        "reason": "reason"
      },
      "resume_point": {
        "fully_played": true,
        "published": true,
        "resume_position_ms": 0
      }
    }
  ]
}