Class SpotifyAPI

Spotify API Client for making requests to the Spotify Web API.

Hierarchy

SpotifyAPI

Index

Constructors

constructor

new SpotifyAPI(options?: SpotifyAPIClientOptions): SpotifyAPI
Create a new Spotify API client.
Parameters
- Optional options: SpotifyAPIClientOptions
  
  Spotify API client options.
Returns SpotifyAPI
- Defined in src/spotify.ts:45

Properties

auth

auth: Auth

Methods

addToMySavedAlbums

addToMySavedAlbums(albumIDs: string[]): Promise<SaveAlbumsForUserResponse>
Save one or more albums to the current user's "Your Music" library.

See
Save Albums for Current User
Parameters
- albumIDs: string[]
  
  The ids of the albums.
Returns Promise<SaveAlbumsForUserResponse>
- Defined in src/spotify.ts:201

addToMySavedShows

addToMySavedShows(showIDs: string[]): Promise<SaveShowsForUserResponse>
Adds a list of shows to the current user's saved shows.

See
Save Shows for Current User
Parameters
- showIDs: string[]
  
  The ids of the shows.
Returns Promise<SaveShowsForUserResponse>
- Defined in src/spotify.ts:1329

addToMySavedTracks

addToMySavedTracks(trackIDs: string[]): Promise<UsersSavedTracksResponse>
Adds a list of tracks to the current user's saved tracks.

See
Save Tracks for Current User
Parameters
- trackIDs: string[]
  
  The ids of the tracks.
Returns Promise<UsersSavedTracksResponse>
- Defined in src/spotify.ts:148

addToPlaylist

addToPlaylist(playlistID: string, itemURIs: string[]): Promise<AddTracksToPlaylistResponse>
Add items to a playlist.

See
Add Items to a Playlist
Parameters
- playlistID: string
  
  The id of the playlist.
- itemURIs: string[]
  
  A list of Spotify URIs for the items to be added.
Returns Promise<AddTracksToPlaylistResponse>
- Defined in src/spotify.ts:534

addTracksToPlaylist

addTracksToPlaylist(playlistID: string, trackURIs: string[]): Promise<AddTracksToPlaylistResponse>
Add tracks to a playlist.

See
Add Tracks to a Playlist

See
addToPlaylist for adding any items.

Remarks
This method is a convenience method for addToPlaylist.
Parameters
- playlistID: string
  
  The id of the playlist.
- trackURIs: string[]
  
  A list of Spotify URIs for the tracks.
Returns Promise<AddTracksToPlaylistResponse>
- Defined in src/spotify.ts:556

addTracksToPlaylistWithIDs

addTracksToPlaylistWithIDs(playlistID: string, trackIDs: string[]): Promise<AddTracksToPlaylistResponse>
Add tracks to a playlist using Spotify IDs.

See
Add Tracks to a Playlist

See
- addTracksToPlaylist for adding tracks using Spotify URIs.
- addToPlaylist for adding any items.
Remarks
This method is a convenience method for addToPlaylist.
Parameters
- playlistID: string
  
  The id of the playlist.
- trackIDs: string[]
  
  A list of Spotify IDs for the tracks.
Returns Promise<AddTracksToPlaylistResponse>
- Defined in src/spotify.ts:572

areFollowingPlaylist

areFollowingPlaylist(playlistID: string, userIDs: string[]): Promise<UsersFollowPlaylistResponse>
Check to see if one or more Spotify users are following a specified playlist.

See
Check if Users Follow a Playlist
Parameters
- playlistID: string
  
  The id of the playlist.
- userIDs: string[]
  
  The ids of the users.
Returns Promise<UsersFollowPlaylistResponse>
- Defined in src/spotify.ts:408

changePlaylistDetails

changePlaylistDetails(playlistID: string, options: PlaylistOptions): Promise<ChangePlaylistDetailsResponse>
Change a playlist's name and public/private state

See
Change a Playlist's Details
Parameters
- playlistID: string
  
  The id of the playlist.
- options: PlaylistOptions
  
  The options for changing the playlist details.
Returns Promise<ChangePlaylistDetailsResponse>
- Defined in src/spotify.ts:516

clearPlaylist

clearPlaylist(playlistID: string): Promise<ReplacePlaylistTracksResponse>
Remove all items from a playlist

See
Replace a Playlist's Tracks
Parameters
- playlistID: string
  
  The id of the playlist.
Returns Promise<ReplacePlaylistTracksResponse>
- Defined in src/spotify.ts:585

containsMySavedAlbums

containsMySavedAlbums(albumIDs: string[]): Promise<CheckUserSavedAlbumsResponse>
Check if one or more albums is already saved in the current Spotify user's "Your Music" library.

See
Check User's Saved Albums
Parameters
- albumIDs: string[]
  
  The ids of the albums.
Returns Promise<CheckUserSavedAlbumsResponse>
- Defined in src/spotify.ts:233

containsMySavedShows

containsMySavedShows(showIDs: string[]): Promise<CheckUserSavedShowsResponse>
Checks if the current user's saved shows contains a certain list of shows.

See
Check Current User's Saved Shows
Parameters
- showIDs: string[]
  
  The ids of the shows.
Returns Promise<CheckUserSavedShowsResponse>
- Defined in src/spotify.ts:1359

containsMySavedTracks

containsMySavedTracks(trackIDs: string[]): Promise<CheckUsersSavedTracksResponse>
Checks if the current user's saved tracks contains a certain list of tracks.

See
Check Current User's Saved Tracks
Parameters
- trackIDs: string[]
  
  The ids of the tracks.
Returns Promise<CheckUsersSavedTracksResponse>
- Defined in src/spotify.ts:178

createPlaylist

createPlaylist(userID: string, options: PlaylistOptions): Promise<CreatePlaylistResponse>
Creates a playlist and stores it in the current user's library.

See
Create a Playlist
Parameters
- userID: string
  
  The id of the user.
- options: PlaylistOptions
  
  Options for playlist creation.
Returns Promise<CreatePlaylistResponse>
- Defined in src/spotify.ts:498

followArtists

followArtists(artistIDs: string[]): Promise<FollowArtistsOrUsersResponse>
Adds the current user as a follower of one or more artists.

See
Follow Artists or Users
Parameters
- artistIDs: string[]
  
  The ids of the artists.
Returns Promise<FollowArtistsOrUsersResponse>
- Defined in src/spotify.ts:289

followPlaylist

followPlaylist(playlistID: string): Promise<FollowPlaylistResponse>
Add the current user as a follower of one playlist.

See
Follow a Playlist
Parameters
- playlistID: string
  
  The id of the playlist.
Returns Promise<FollowPlaylistResponse>
- Defined in src/spotify.ts:306

followUsers

followUsers(userIDs: string[]): Promise<FollowArtistsOrUsersResponse>
Adds the current user as a follower of one or more other Spotify users.

See
Follow Artists or Users
Parameters
- userIDs: string[]
  
  The ids of the users.
Returns Promise<FollowArtistsOrUsersResponse>
- Defined in src/spotify.ts:272

getAlbum

getAlbum(albumID: string): Promise<SingleAlbumResponse>
Fetches an album from the Spotify catalog.

See
Get an Album
Parameters
- albumID: string
  
  The id of the album.
Returns Promise<SingleAlbumResponse>
- Defined in src/spotify.ts:798

getAlbumTracks

getAlbumTracks(albumID: string): Promise<AlbumTracksResponse>
Fetches the tracks of an album from the Spotify catalog.

See
Get an Album's Tracks
Parameters
- albumID: string
  
  The id of the album.
Returns Promise<AlbumTracksResponse>
- Defined in src/spotify.ts:807

getAlbums

getAlbums(albumIDs: string[]): Promise<MultipleAlbumsResponse>
Fetches multiple albums from the Spotify catalog.

See
Get Several Albums
Parameters
- albumIDs: string[]
  
  The ids of the albums.
Returns Promise<MultipleAlbumsResponse>
- Defined in src/spotify.ts:816

getApiUrl

getApiUrl(): string
Get the set API URL.

Returns string
- Defined in src/spotify.ts:55

getArtist

getArtist(artistID: string): Promise<SingleArtistResponse>
Fetches an artist from the Spotify catalog.

See
Get an Artist
Parameters
- artistID: string
  
  The id of the artist.
Returns Promise<SingleArtistResponse>
- Defined in src/spotify.ts:851

getArtistAlbums

getArtistAlbums(artistID: string): Promise<ArtistsAlbumsResponse>
Fetches the albums of an artist from the Spotify catalog.

See
Get an Artist's Albums
Parameters
- artistID: string
  
  The id of the artist.
Returns Promise<ArtistsAlbumsResponse>
- Defined in src/spotify.ts:873

getArtistRelatedArtists

getArtistRelatedArtists(artistID: string): Promise<ArtistsRelatedArtistsResponse>
Fetches a list of artists related with a given one from the Spotify catalog.

See
Get an Artist's Related Artists
Parameters
- artistID: string
  
  The id of the artist.
Returns Promise<ArtistsRelatedArtistsResponse>
- Defined in src/spotify.ts:901

getArtistTopTracks

getArtistTopTracks(artistID: string, countryID: string): Promise<ArtistsTopTracksResponse>
Fetches a list of top tracks of an artist from the Spotify catalog, for a specific country.

See
Get an Artist's Top Tracks
Parameters
- artistID: string
  
  The id of the artist. If you know the Spotify URI it is easy to find the
- countryID: string
  
  The id of the country (e.g. ES for Spain or US for United States)
Returns Promise<ArtistsTopTracksResponse>
- Defined in src/spotify.ts:884

getArtists

getArtists(artistIDs: string[]): Promise<MultipleArtistsResponse>
Fetches multiple artists from the Spotify catalog.

See
Get Several Artists
Parameters
- artistIDs: string[]
  
  The ids of the artists.
Returns Promise<MultipleArtistsResponse>
- Defined in src/spotify.ts:860

getAudioAnalysisForTrack

getAudioAnalysisForTrack(trackID: string): Promise<AudioAnalysisTrack>
Get audio analysis for a single track identified by its unique Spotify ID.

See
Get Audio Analysis for a Track
Parameters
- trackID: string
  
  The id of the track.
Returns Promise<AudioAnalysisTrack>
- Defined in src/spotify.ts:1053

getAudioFeaturesForTrack

getAudioFeaturesForTrack(trackID: string): Promise<AudioFeaturesResponse>
Get audio features for a single track identified by its unique Spotify ID.

See
Get Audio Features for a Track
Parameters
- trackID: string
  
  The id of the track.
Returns Promise<AudioFeaturesResponse>
- Defined in src/spotify.ts:1029

getAudioFeaturesForTracks

getAudioFeaturesForTracks(trackIDs: string[]): Promise<MultipleAudioFeaturesResponse>
Get audio features for multiple tracks based on their Spotify IDs.

See
Get Audio Features for Several Tracks
Parameters
- trackIDs: string[]
  
  The ids of the tracks.
Returns Promise<MultipleAudioFeaturesResponse>
- Defined in src/spotify.ts:1038

getAvailableGenreSeeds

getAvailableGenreSeeds(): Promise<AvailableGenreSeedsResponse>
Retrieve a list of available genres seed parameter values for recommendations.

See
Available Genre Seeds

Returns Promise<AvailableGenreSeedsResponse>
- Defined in src/spotify.ts:1076

getCategories

getCategories(): Promise<MultipleCategoriesResponse>
Get a list of categories used to tag items in Spotify (on, for example, the Spotify player's "Browse" tab).

See
Get a List of Categories

Returns Promise<MultipleCategoriesResponse>
- Defined in src/spotify.ts:927

getCategory

getCategory(categoryID: string): Promise<SingleCategoryResponse>
Get a single category used to tag items in Spotify (on, for example, the Spotify player's "Browse" tab).

See
Get a Category
Parameters
- categoryID: string
  
  The id of the category. These can be found with the getCategories function.
Returns Promise<SingleCategoryResponse>
- Defined in src/spotify.ts:936

getCategoryPlaylists

getCategoryPlaylists(categoryID: string): Promise<CategoryPlaylistsResponse>
Get a list of Spotify playlists tagged with a particular category.

See
Get a Category's Playlists
Parameters
- categoryID: string
  
  The id of the category. These can be found with the getCategories function.
Returns Promise<CategoryPlaylistsResponse>
- Defined in src/spotify.ts:945

getEpisode

getEpisode(episodeID: string, market?: string): Promise<EpisodeObject>
Fetches an episode from the Spotify catalog.

See
Get an Episode
Parameters
- episodeID: string
  
  The id of the episode.
- Optional market: string
Returns Promise<EpisodeObject>
- Defined in src/spotify.ts:1390

getEpisodes

getEpisodes(episodeIDs: string[], market?: string): Promise<MultipleEpisodesResponse>
Fetches multiple episodes from the Spotify catalog.

See
Get Several Episodes
Parameters
- episodeIDs: string[]
  
  The ids of the episodes.
- Optional market: string
Returns Promise<MultipleEpisodesResponse>
- Defined in src/spotify.ts:1406

getFeaturedPlaylists

getFeaturedPlaylists(): Promise<ListOfFeaturedPlaylistsResponse>
Fetches a list of Spotify featured playlists (shown, for example, on a Spotify player's "Browse" tab).

See
Get a List of Featured Playlists

Returns Promise<ListOfFeaturedPlaylistsResponse>
- Defined in src/spotify.ts:911

getFollowedArtists

getFollowedArtists(): Promise<UsersFollowedArtistsResponse>
Get the current user's followed artists.

See
Get User's Followed Artists

Returns Promise<UsersFollowedArtistsResponse>
- Defined in src/spotify.ts:426

getMe

getMe(): Promise<UserProfileResponse>
Get detailed profile information about the current user (including the current user's username).

See
Get Current User's Profile

Returns Promise<UserProfileResponse>
- Defined in src/spotify.ts:131

getMyCurrentPlaybackState

getMyCurrentPlaybackState(): Promise<CurrentPlaybackResponse>
Get information about the user’s current playback state, including track, track progress, and active device.

See
Get Information About The User’s Current Playback

Returns Promise<CurrentPlaybackResponse>
- Defined in src/spotify.ts:1092

getMyCurrentPlayingTrack

getMyCurrentPlayingTrack(): Promise<CurrentlyPlayingResponse>
Get the object currently being played on the user’s Spotify account.

See
Get the User’s Currently Playing Track

Returns Promise<CurrentlyPlayingResponse>
- Defined in src/spotify.ts:1100

getMyDevices

getMyDevices(): Promise<UserDevicesResponse>
Get information about a user’s available devices.

See
Get a User’s Available Devices

Returns Promise<UserDevicesResponse>
- Defined in src/spotify.ts:1084

getMyPlaylists

getMyPlaylists(): Promise<ListOfUsersPlaylistsResponse>
Fetches a list of the current user's playlists.

See
Get a List of a User's Playlists

Returns Promise<ListOfUsersPlaylistsResponse>
- Defined in src/spotify.ts:459

getMyRecentlyPlayedTracks

getMyRecentlyPlayedTracks(): Promise<UsersRecentlyPlayedTracksResponse>
Get tracks from the current user’s recently played tracks.

See
Get Current User’s Recently Played Tracks

Returns Promise<UsersRecentlyPlayedTracksResponse>
- Defined in src/spotify.ts:263

getMySavedAlbums

getMySavedAlbums(): Promise<UsersSavedAlbumsResponse>
Get a list of the albums saved in the current Spotify user's "Your Music" library.

See
Get Current User's Saved Albums

Returns Promise<UsersSavedAlbumsResponse>
- Defined in src/spotify.ts:192

getMySavedShows

getMySavedShows(): Promise<UsersSavedShowsResponse>
Fetches current user's saved shows.

See
Get Current User's Saved Shows

Returns Promise<UsersSavedShowsResponse>
- Defined in src/spotify.ts:1320

getMySavedTracks

getMySavedTracks(): Promise<UsersSavedTracksResponse>
Fetches current user's saved tracks.

See
Get Current User's Saved Tracks

Returns Promise<UsersSavedTracksResponse>
- Defined in src/spotify.ts:139

getMyTopArtists

getMyTopArtists(): Promise<UsersTopArtistsResponse>
Get the current user’s top artists based on calculated affinity.

See
Get a User’s Top Artists

Returns Promise<UsersTopArtistsResponse>
- Defined in src/spotify.ts:247

getMyTopTracks

getMyTopTracks(): Promise<UsersTopTracksResponse>
Get the current user’s top tracks based on calculated affinity.

See
Get a User’s Top Tracks

Returns Promise<UsersTopTracksResponse>
- Defined in src/spotify.ts:255

getNewReleases

getNewReleases(): Promise<ListOfNewReleasesResponse>
Fetches a list of new album releases featured in Spotify (shown, for example, on a Spotify player's "Browse" tab).

See
Get a List of New Releases

Returns Promise<ListOfNewReleasesResponse>
- Defined in src/spotify.ts:919

getPlaylist

getPlaylist(playlistID: string): Promise<SinglePlaylistResponse>
Fetches a specific playlist.

See
Get a Playlist
Parameters
- playlistID: string
  
  The id of the playlist.
Returns Promise<SinglePlaylistResponse>
- Defined in src/spotify.ts:468

getPlaylistCoverImage

getPlaylistCoverImage(playlistID: string): Promise<PlaylistCoverImageResponse>
Gets the current image associated with a specific playlist.

See
Get a Playlist Cover Image
Parameters
- playlistID: string
  
  The id of the playlist.
Returns Promise<PlaylistCoverImageResponse>
- Defined in src/spotify.ts:486

getPlaylistTracks

getPlaylistTracks(playlistID: string): Promise<PlaylistTrackResponse>
Fetches the tracks from a specific playlist.

See
Get a Playlist's Tracks
Parameters
- playlistID: string
  
  The id of the playlist.
Returns Promise<PlaylistTrackResponse>
- Defined in src/spotify.ts:477

getRecommendations

getRecommendations(options: RecommendationsOptionsObject): Promise<RecommendationsFromSeedsResponse>
Create a playlist-style listening experience based on seed artists, tracks and genres.

See
Get Recommendations Based on Seeds
Parameters
- options: RecommendationsOptionsObject
  
  An object with optional keys limit, market, min_*, etc...
Returns Promise<RecommendationsFromSeedsResponse>
- Defined in src/spotify.ts:1062

getShow

getShow(showID: string, market?: string): Promise<ShowObject>
Fetches a show from the Spotify catalog.

See
Get a Show
Parameters
- showID: string
  
  The id of the show.
- Optional market: string
Returns Promise<ShowObject>
- Defined in src/spotify.ts:1292

getShowEpisodes

getShowEpisodes(showID: string, market?: string): Promise<ShowEpisodesResponse>
Fetches the episodes of a show from the Spotify catalog.

See
Get a Show's Episodes
Parameters
- showID: string
  
  The id of the show.
- Optional market: string
Returns Promise<ShowEpisodesResponse>
- Defined in src/spotify.ts:1374

getShows

getShows(showIDs: string[], market?: string): Promise<MultipleShowsResponse>
Fetches multiple shows from the Spotify catalog.

See
Get Several Shows
Parameters
- showIDs: string[]
  
  The ids of the shows.
- Optional market: string
Returns Promise<MultipleShowsResponse>
- Defined in src/spotify.ts:1305

getTrack

getTrack(trackID: string): Promise<SingleTrackResponse>
Fetches a track from the Spotify catalog.

See
Get a Track
Parameters
- trackID: string
  
  The id of the track.
Returns Promise<SingleTrackResponse>
- Defined in src/spotify.ts:829

getTracks

getTracks(trackIDs: string[]): Promise<MultipleTracksResponse>
Fetches multiple tracks from the Spotify catalog.

See
Get Several Tracks
Parameters
- trackIDs: string[]
  
  The ids of the tracks.
Returns Promise<MultipleTracksResponse>
- Defined in src/spotify.ts:838

getUser

getUser(userID: string): Promise<UserProfileResponse>
Fetches information about a specific user.

See
Get a User's Profile
Parameters
- userID: string
  
  The id of the user.
Returns Promise<UserProfileResponse>
- Defined in src/spotify.ts:442

getUserPlaylists

getUserPlaylists(userID: string): Promise<ListOfUsersPlaylistsResponse>
Fetches a list of a user's playlists.

See
Get a List of a User's Playlists
Parameters
- userID: string
  
  The id of the user.
Returns Promise<ListOfUsersPlaylistsResponse>
- Defined in src/spotify.ts:451

isFollowingArtists

isFollowingArtists(artistIDs: string[]): Promise<UserFollowsUsersOrArtistsResponse>
Checks to see if the current user is following one or more artists.

See
Check if Current User Follows
Parameters
- artistIDs: string[]
  
  The ids of the artists.
Returns Promise<UserFollowsUsersOrArtistsResponse>
- Defined in src/spotify.ts:388

isFollowingUsers

isFollowingUsers(userIDs: string[]): Promise<UserFollowsUsersOrArtistsResponse>
Checks to see if the current user is following one or more other Spotify users.

See
Check if Current User Follows Users or Artists
Parameters
- userIDs: string[]
  
  The ids of the users.
Returns Promise<UserFollowsUsersOrArtistsResponse>
- Defined in src/spotify.ts:369

pause

pause(options: DeviceOptions): Promise<any>
Pause playback on the user’s account.

See
Pause a User’s Playback
Parameters
- options: DeviceOptions
  
  An object with options that can be passed.
Returns Promise<any>
- Defined in src/spotify.ts:1166

play

play(options: PlayOptions): Promise<any>
Play a track on the user's active device

See
Start/Resume a User's Playback
Parameters
- options: PlayOptions
  
  An object with options that can be passed.
Returns Promise<any>
- Defined in src/spotify.ts:1128

queue

queue(uri: string, options: DeviceOptions): Promise<AddToQueueResponse>
Add an item to the end of the user’s current playback queue.

See
Add an Item to the User's Playback Queue
Parameters
- uri: string
  
  The uri of the item to add to the queue. Must be a track or an episode uri.
- options: DeviceOptions
  
  A JSON object with options that can be passed.
Returns Promise<AddToQueueResponse>
- Defined in src/spotify.ts:1149

removeFromMySavedAlbums

removeFromMySavedAlbums(albumIDs: string[]): Promise<RemoveAlbumsForUserResponse>
Remove one or more albums from the current user's "Your Music" library.

See
Remove Albums for Current User
Parameters
- albumIDs: string[]
  
  The ids of the albums.
Returns Promise<RemoveAlbumsForUserResponse>
- Defined in src/spotify.ts:217

removeFromMySavedShows

removeFromMySavedShows(showIDs: string[]): Promise<RemoveShowsForUserResponse>
Remove a list of shows from the current user's saved shows.

See
Remove Shows for Current User
Parameters
- showIDs: string[]
  
  The ids of the shows.
Returns Promise<RemoveShowsForUserResponse>
- Defined in src/spotify.ts:1343

removeFromMySavedTracks

removeFromMySavedTracks(trackIDs: string[]): Promise<RemoveUsersSavedTracksResponse>
Remove a list of tracks from the current user's saved tracks.

See
Remove Tracks for Current User
Parameters
- trackIDs: string[]
  
  The ids of the tracks.
Returns Promise<RemoveUsersSavedTracksResponse>
- Defined in src/spotify.ts:162

removeFromPlaylist

removeFromPlaylist(playlistID: string, itemURIs: string[]): Promise<RemoveTracksFromPlaylistResponse>
Remove items from a playlist

See
Remove Tracks from a Playlist
Parameters
- playlistID: string
  
  The id of the playlist.
- itemURIs: string[]
  
  A list of items to be removed.
Returns Promise<RemoveTracksFromPlaylistResponse>
- Defined in src/spotify.ts:678

removeFromPlaylistInPositions

removeFromPlaylistInPositions(playlistID: string, positions: number[], snapshotID: string): Promise<RemoveTracksFromPlaylistResponse>
Remove items from a playlist, specifying the positions of the items to be removed.

See
Remove Tracks from a Playlist
Parameters
- playlistID: string
  
  The id of the playlist.
- positions: number[]
  
  A list of integers containing the positions of the items to remove from the playlist.
- snapshotID: string
  
  The playlist's snapshot ID against which you want to make the changes
Returns Promise<RemoveTracksFromPlaylistResponse>
- Defined in src/spotify.ts:758

removeItemsFromPlaylistWithSnapshotID

removeItemsFromPlaylistWithSnapshotID(playlistID: string, itemURIs: string[], snapshotID: string): Promise<RemoveTracksFromPlaylistResponse>
Remove tracks from a playlist, specifying a snapshot id.

See
Remove Tracks from a Playlist
Parameters
- playlistID: string
  
  The id of the playlist.
- itemURIs: string[]
  
  A list of tracks to be removed.
- snapshotID: string
  
  The playlist's snapshot ID against which you want to make the changes
Returns Promise<RemoveTracksFromPlaylistResponse>
- Defined in src/spotify.ts:731

removeTracksFromPlaylist

removeTracksFromPlaylist(playlistID: string, trackURIs: string[]): Promise<RemoveTracksFromPlaylistResponse>
Remove tracks from a playlist.

See
Remove Tracks from a Playlist

See
removeFromPlaylist for removing any items.

Remarks
This method is a convenience method for removeFromPlaylist.
Parameters
- playlistID: string
  
  The id of the playlist.
- trackURIs: string[]
  
  A list of tracks to be removed.
Returns Promise<RemoveTracksFromPlaylistResponse>
- Defined in src/spotify.ts:702

removeTracksFromPlaylistWithIDs

removeTracksFromPlaylistWithIDs(playlistID: string, trackIDs: string[]): Promise<RemoveTracksFromPlaylistResponse>
Remove tracks from a playlist.

See
Remove Tracks from a Playlist

See
removeFromPlaylist for removing any items.

Remarks
This method is a convenience method for removeFromPlaylist.
Parameters
- playlistID: string
  
  The id of the playlist.
- trackIDs: string[]
  
  A list of tracks to be removed.
Returns Promise<RemoveTracksFromPlaylistResponse>
- Defined in src/spotify.ts:717

reorderItemsInPlaylist

reorderItemsInPlaylist(playlistID: string, rangeStart: number, insertBefore: number, rangeLength?: number, snapshotID?: number): Promise<ReorderPlaylistTracksResponse>
Reorder items in a playlist

See
Reorder a Playlist’s Tracks
Parameters
- playlistID: string
  
  The id of the playlist.
- rangeStart: number
  
  The position of the first track to be reordered.
- insertBefore: number
  
  The position where the tracks should be inserted. To reorder the tracks to the end of the playlist, simply set insert_before to the position after the last track.
- Optional rangeLength: number
- Optional snapshotID: number
  
  The playlist’s snapshot ID against which you want to make the changes.
Returns Promise<ReorderPlaylistTracksResponse>
- Defined in src/spotify.ts:652

replacePlaylistItems

replacePlaylistItems(playlistID: string, itemURIs: string[]): Promise<ReplacePlaylistTracksResponse>
Replace the items in a playlist with a list of items.

See
Replace a Playlist's Tracks
Parameters
- playlistID: string
  
  The id of the playlist.
- itemURIs: string[]
  
  A list of Spotify URIs for the items
Returns Promise<ReplacePlaylistTracksResponse>
- Defined in src/spotify.ts:599

replacePlaylistItemsWithTrackIDs

replacePlaylistItemsWithTrackIDs(playlistID: string, trackIDs: string[]): Promise<ReplacePlaylistTracksResponse>
Replace the tracks of a playlist

See
Replace a Playlist's Tracks

See
- replacePlaylistItems for replacing tracks using Spotify URIs.
- replacePlaylistItems for replacing any items.
Remarks
This method is a convenience method for replacePlaylistItems.
Parameters
- playlistID: string
  
  The id of the playlist.
- trackIDs: string[]
Returns Promise<ReplacePlaylistTracksResponse>
- Defined in src/spotify.ts:635

replacePlaylistItemsWithTracks

replacePlaylistItemsWithTracks(playlistID: string, trackURIs: string[]): Promise<ReplacePlaylistTracksResponse>
Replace the items in a playlist with a list of tracks.

See
Replace a Playlist's Tracks

See
replacePlaylist for replacing with any items.

Remarks
This method is a convenience method for replaceInPlaylist.
Parameters
- playlistID: string
  
  The id of the playlist.
- trackURIs: string[]
  
  A list of Spotify URIs for the tracks
Returns Promise<ReplacePlaylistTracksResponse>
- Defined in src/spotify.ts:619

request

request(options: string | SpotifyRequestOptions): Promise<any>
Make a request to the Spotify API. This method is used internally by the other methods but can be called directly if you want to make a request that is not yet implemented or modify an existing request.

Remarks
The method will automatically refresh the access token if it is expired, unless the refreshExpiredAccessToken option is set to false. It will also make GET requests by default if no method is specified.
Parameters
- options: string | SpotifyRequestOptions
  
  The options for the request to the Spotify API. A url as a string can be specified instead to make GET request to the specified url.
Returns Promise<any>
- Defined in src/spotify.ts:77

search

search(query: string, types: string[]): Promise<any>
Get Spotify catalog information about artists, albums, tracks or playlists that match a keyword string.

See
Search for an Item
Parameters
- query: string
  
  The search query
- types: string[]
  
  A list of item types to search across. Valid types are: 'album', 'artist', 'playlist', and 'track'.
Returns Promise<any>
- Defined in src/spotify.ts:959

searchAlbums

searchAlbums(query: string): Promise<AlbumSearchResponse>
Fetches albums from the Spotify catalog according to a query.

See
Search for an Item
Parameters
- query: string
  
  The search query
Returns Promise<AlbumSearchResponse>
- Defined in src/spotify.ts:975

searchArtists

searchArtists(query: string): Promise<ArtistSearchResponse>
Fetches artists from the Spotify catalog according to a query.

See
Search for an Item
Parameters
- query: string
  
  The search query
Returns Promise<ArtistSearchResponse>
- Defined in src/spotify.ts:984

searchEpisodes

searchEpisodes(query: string): Promise<EpisodeSearchResponse>
Fetches episodes from the Spotify catalog according to a query.

See
Search for an Item
Parameters
- query: string
  
  The search query
Returns Promise<EpisodeSearchResponse>
- Defined in src/spotify.ts:1020

searchPlaylists

searchPlaylists(query: string): Promise<PlaylistSearchResponse>
Fetches playlists from the Spotify catalog according to a query.

See
Search for an Item
Parameters
- query: string
  
  The search query
Returns Promise<PlaylistSearchResponse>
- Defined in src/spotify.ts:1002

searchShows

searchShows(query: string): Promise<ShowSearchResponse>
Fetches shows from the Spotify catalog according to a query.

See
Search for an Item
Parameters
- query: string
  
  The search query
Returns Promise<ShowSearchResponse>
- Defined in src/spotify.ts:1011

searchTracks

searchTracks(query: string): Promise<TrackSearchResponse>
Fetches tracks from the Spotify catalog according to a query.

See
Search for an Item
Parameters
- query: string
  
  The search query
Returns Promise<TrackSearchResponse>
- Defined in src/spotify.ts:993

seek

seek(position_ms: number, options: SeekOptions): Promise<any>
Seeks to the given position in the user’s currently playing track.

See
Seek To Position In Currently Playing Track
Parameters
- position_ms: number
  
  The position in milliseconds to seek to. Must be a positive number.
- options: SeekOptions
  
  An object with options that can be passed.
Returns Promise<any>
- Defined in src/spotify.ts:1214

setCustomFetch

setCustomFetch(fetch: any): void
Set the API client to use a custom fetch implementation.
Parameters
- fetch: any
  
  A custom fetch implementation.
Returns void
- Defined in src/spotify.ts:65

setRepeat

setRepeat(state: string, options: SetRepeatOptions): Promise<any>
Set the repeat mode for the user’s playback. Options are repeat-track, repeat-context, and off.

See
Set Repeat Mode On User’s Playback
Parameters
- state: string
  
  A string set to 'track', 'context' or 'off'.
- options: SetRepeatOptions
  
  An object with options that can be passed.
Returns Promise<any>
- Defined in src/spotify.ts:1234

setShuffle

setShuffle(state: boolean, options: SetShuffleOptions): Promise<any>
Toggle shuffle on or off for user’s playback.

See
Toggle Shuffle For User’s Playback
Parameters
- state: boolean
  
  Whether or not to shuffle user's playback.
- options: SetShuffleOptions
  
  An object with options that can be passed.
Returns Promise<any>
- Defined in src/spotify.ts:1274

setVolume

setVolume(volume_percent: number, options: SetVolumeOptions): Promise<any>
Set the volume for the user’s current playback device.

See
Set Volume For User’s Playback
Parameters
- volume_percent: number
  
  The volume to set. Must be a value from 0 to 100 inclusive.
- options: SetVolumeOptions
  
  An object with options that can be passed.
Returns Promise<any>
- Defined in src/spotify.ts:1254

skipToNext

skipToNext(options: DeviceOptions): Promise<any>
Skips to next track in the user’s queue.

See
Skip User’s Playback To Next Track
Parameters
- options: DeviceOptions
  
  An object with options that can be passed.
Returns Promise<any>
- Defined in src/spotify.ts:1181

skipToPrevious

skipToPrevious(options: DeviceOptions): Promise<any>
Skips to previous track in the user’s queue. Note that this will ALWAYS skip to the previous track, regardless of the current track’s progress. Returning to the start of the current track should be performed using .seek()

See
Skip User’s Playback To Previous Track
Parameters
- options: DeviceOptions
  
  An object with options that can be passed.
Returns Promise<any>
- Defined in src/spotify.ts:1198

transferMyPlayback

transferMyPlayback(deviceID: string): Promise<any>
Transfer playback to a new device and determine if it should start playing.

See
Transfer a User’s Playback
Parameters
- deviceID: string
  
  The ID of the device on which playback should be started/transferred.
Returns Promise<any>
- Defined in src/spotify.ts:1111

unfollowArtists

unfollowArtists(artistIDs: string[]): Promise<UnfollowArtistsOrUsersResponse>
Removes the current user as a follower of one or more artists.

See
Unfollow Artists or Users
Parameters
- artistIDs: string[]
  
  The ids of the artists.
Returns Promise<UnfollowArtistsOrUsersResponse>
- Defined in src/spotify.ts:337

unfollowPlaylist

unfollowPlaylist(playlistID: string): Promise<UnfollowPlaylistResponse>
Remove the current user as a follower of one playlist.

See
Unfollow a Playlist
Parameters
- playlistID: string
  
  The id of the playlist.
Returns Promise<UnfollowPlaylistResponse>
- Defined in src/spotify.ts:356

unfollowUsers

unfollowUsers(userIDs: string[]): Promise<UnfollowArtistsOrUsersResponse>
Removes the current user as a follower of one or more other Spotify users.

See
Unfollow Artists or Users
Parameters
- userIDs: string[]
  
  The ids of the users.
Returns Promise<UnfollowArtistsOrUsersResponse>
- Defined in src/spotify.ts:320

uploadCustomPlaylistCoverImage

uploadCustomPlaylistCoverImage(playlistID: string, imageData: string): Promise<UploadCustomPlaylistCoverImageResponse>
Upload a custom playlist cover image.

See
Upload A Custom Playlist Cover Image
Parameters
- playlistID: string
  
  The id of the playlist.
- imageData: string
  
  Base64 encoded JPEG image data, maximum payload size is 256 KB.
Returns Promise<UploadCustomPlaylistCoverImageResponse>
- Defined in src/spotify.ts:780

Class SpotifyAPI

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional options: SpotifyAPIClientOptions

Returns SpotifyAPI

Properties

auth

Methods

addToMySavedAlbums

See

Parameters

albumIDs: string[]

Returns Promise<SaveAlbumsForUserResponse>

addToMySavedShows

See

Parameters

showIDs: string[]

Returns Promise<SaveShowsForUserResponse>

addToMySavedTracks

See

Parameters

trackIDs: string[]

Returns Promise<UsersSavedTracksResponse>

addToPlaylist

See

Parameters

playlistID: string

itemURIs: string[]

Returns Promise<AddTracksToPlaylistResponse>

addTracksToPlaylist

See

See

Remarks

Parameters

playlistID: string

trackURIs: string[]

Returns Promise<AddTracksToPlaylistResponse>

addTracksToPlaylistWithIDs

See

See

Remarks

Parameters

playlistID: string

trackIDs: string[]

Returns Promise<AddTracksToPlaylistResponse>

areFollowingPlaylist

See

Parameters

playlistID: string

userIDs: string[]

Returns Promise<UsersFollowPlaylistResponse>

changePlaylistDetails

See

Parameters

playlistID: string

options: PlaylistOptions

Returns Promise<ChangePlaylistDetailsResponse>

clearPlaylist

See

Parameters

playlistID: string

Returns Promise<ReplacePlaylistTracksResponse>

containsMySavedAlbums

See

Parameters

albumIDs: string[]

Returns Promise<CheckUserSavedAlbumsResponse>

containsMySavedShows

See

Parameters

showIDs: string[]

Returns Promise<CheckUserSavedShowsResponse>

containsMySavedTracks

See

`Optional` options: SpotifyAPIClientOptions