Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • EpisodesApi

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private http

http: Http

Methods

getEpisode

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

    Required Scopes: user-read-playback-position for reading the user's resume points.

    example
    const episode = await spotify.episodes.getEpisode('5VhaAEtTrKQ1NSneHsXK6C');
    console.log(episode.name);
    // "S1E6 - Institutionalized by Kendrick Lamar"

    Parameters

    • episodeId: string
    • Optional options: MarketOptions

      Optional request information.

    Returns Promise<Episode>

getEpisodes

  • Get Spotify catalog information for multiple episodes based on their Spotify IDs.

    Required Scopes: user-read-playback-position for reading the user's resume points.

    example
    const episodes = await spotify.episodes.getEpisodes([
     '3Ht9rzglNNgJBFGp2RL7o2',
     '7r40piSdCht1NL720dKNWf',
    ]);
    console.log(episodes.map(episode => episode.name));
    // Array [ "The Soul Train Episode", "How the Voyager Golden Records Work" ]

    Parameters

    • episodeIds: string[]

      A list of the Spotify IDs for the episodes.

    • Optional options: MarketOptions

      Optional request information.

    Returns Promise<Array<Episode | null>>

Generated using TypeDoc