Get Episode

client.Episodes.Get(ctx, id, query) (*EpisodeObject, error)

GET/episodes/{id}

Get Spotify catalog information for a single episode identified by its unique Spotify ID.

ParametersExpand Collapse

id string

The Spotify ID for the episode.

query EpisodeGetParams

Market param.Field[string]optional

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

type EpisodeObject struct{…}

ID string

The Spotify ID for the episode.

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

DurationMs int64

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

ExternalURLs ExternalURLObject

External URLs for this episode.

Published booloptional

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 stringoptional

The Spotify URL for the object.

Href string

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

HTMLDescription string

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

Images []ImageObject

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

Height int64

The image height in pixels.

URL string

The source URL of the image.

Width int64

The image width in pixels.

Published booloptional

IsExternallyHosted bool

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

IsPlayable bool

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

Languages []string

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

Name string

The name of the episode.

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

ReleaseDatePrecision EpisodeObjectReleaseDatePrecision

The precision with which release_date value is known.

Accepts one of the following:

const EpisodeObjectReleaseDatePrecisionYear EpisodeObjectReleaseDatePrecision = "year"

const EpisodeObjectReleaseDatePrecisionMonth EpisodeObjectReleaseDatePrecision = "month"

const EpisodeObjectReleaseDatePrecisionDay EpisodeObjectReleaseDatePrecision = "day"

Show ShowBase

The show on which the episode belongs.

ID string

The Spotify ID for the show.

AvailableMarkets []string

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

Copyrights []CopyrightObject

The copyright statements of the show.

Published booloptional

Text stringoptional

The copyright text for this content.

Type stringoptional

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

ExternalURLs ExternalURLObject

External URLs for this show.

Published booloptional

Spotify stringoptional

The Spotify URL for the object.

Href string

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

HTMLDescription string

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

Images []ImageObject

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

Height int64

The image height in pixels.

URL string

The source URL of the image.

Width int64

The image width in pixels.

Published booloptional

IsExternallyHosted bool

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

Languages []string

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

MediaType string

The media type of the show.

Name string

The name of the episode.

Publisher string

The publisher of the show.

TotalEpisodes int64

The total number of episodes in the show.

Type Show

The object type.

Uri string

The Spotify URI for the show.

Published booloptional

Type Episode

The object type.

Uri string

The Spotify URI for the episode.

DeprecatedLanguage stringoptional

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 booloptional

Restrictions EpisodeRestrictionObjectoptional

Included in the response when a content restriction is applied.

Published booloptional

Reason stringoptional

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.

ResumePoint ResumePointObjectoptional

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

FullyPlayed booloptional

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

Published booloptional

ResumePositionMs int64optional

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

Get Episode

package main

import (
  "context"
  "fmt"

  "github.com/cjavdev/spotted-go"
  "github.com/cjavdev/spotted-go/option"
)

func main() {
  client := spotted.NewClient(
    option.WithAccessToken("My Access Token"),
  )
  episodeObject, err := client.Episodes.Get(
    context.TODO(),
    "512ojhOuo1ktJprKbVcKyQ",
    spotted.EpisodeGetParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", episodeObject.ID)
}

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

{
  "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
  }
}