Skip to content
Spotted Docs Spotted Docs
DocumentationAPI Reference
API Reference
Shows

Get Several Shows

shows.bulk_retrieve(**kwargs) -> ShowBulkRetrieveResponse { shows }
GET/shows

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

ParametersExpand Collapse
ids: String

A comma-separated list of the Spotify IDs for the shows. 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 ShowBulkRetrieveResponse { shows }
shows: Array[ShowBase { id, available_markets, copyrights, 15 more } ]
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.

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

text: String

The copyright text for this content.

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

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

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

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

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

Get Several Shows 

require "spotted"

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

response = spotted.shows.bulk_retrieve(ids: "5CfCWKI5pZ28U0uOzXkDHe,5as3aKmN2k11yfDDDSrvaZ")

puts(response)
{
  "shows": [
    {
      "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
    }
  ]
}
Returns Examples
{
  "shows": [
    {
      "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
    }
  ]
}