Version 1
Connector Overview: This page documents all 89 actions for the Spotifyconnector v1.
Albums (8)
GET Check User's Saved Albums
/me/albums/contains
Check if one or more albums is already saved in the current Spotify user's 'Your Music' library.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
A comma-separated list of the Spotify IDs for the albums. Maximum: 20 IDs. |
|
|
N/A |
GET Get Album
/albums/{id}
Get Spotify catalog information for a single album.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The Spotify ID of the album. |
|
|
An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
|
|
|
N/A |
GET Get Album Tracks
/albums/{id}/tracks
Get Spotify catalog information about an album’s tracks.
Optional parameters can be used to limit the number of tracks returned.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The Spotify ID of the album. |
|
|
An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
|
|
|
The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50. |
|
|
The index of the first item to return. Default: 0 (the first item). Use with limit to get the next set of items. |
|
|
N/A |
GET Get New Releases
/browse/new-releases
Get a list of new album releases featured in Spotify (shown, for example, on a Spotify player’s “Browse” tab).
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
A country: an ISO 3166-1 alpha-2 country code. Provide this parameter if you want the list of returned items to be relevant to a particular country. If omitted, the returned items will be relevant to all countries. |
|
|
The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50. |
|
|
The index of the first item to return. Default: 0 (the first item). Use with limit to get the next set of items. |
|
|
N/A |
GET Get Several Albums
/albums
Get Spotify catalog information for multiple albums identified by their Spotify IDs.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
A comma-separated list of the Spotify IDs for the albums. Maximum: 20 IDs. |
|
|
An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
|
|
|
N/A |
GET Get User's Saved Albums
/me/albums
Get a list of the albums saved in the current Spotify user's 'Your Music' library.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50. |
|
|
The index of the first item to return. Default: 0 (the first item). Use with limit to get the next set of items. |
|
|
An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
|
|
|
N/A |
DELETE Remove Users' Saved Albums
/me/albums
Remove one or more albums from the current user's 'Your Music' library.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
A comma-separated list of the Spotify IDs for the albums. Maximum: 20 IDs. |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
A JSON array of the Spotify IDs. For example: ["4iV5W9uYEdYUVa79Axb7Rh", "1301WleyT98MSxVHPZCA6M"]A maximum of 50 items can be specified in one request. _Note: if the ids parameter is present in the query string, any IDs listed here in the body will be ignored._ |
PUT Save Albums for Current User
/me/albums
Save one or more albums to the current user's 'Your Music' library.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
A comma-separated list of the Spotify IDs for the albums. Maximum: 20 IDs. |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
A JSON array of the Spotify IDs. For example: ["4iV5W9uYEdYUVa79Axb7Rh", "1301WleyT98MSxVHPZCA6M"]A maximum of 50 items can be specified in one request. _Note: if the ids parameter is present in the query string, any IDs listed here in the body will be ignored._ |
Artists (5)
GET Get Artist
/artists/{id}
Get Spotify catalog information for a single artist identified by their unique Spotify ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The Spotify ID of the artist. |
|
|
N/A |
GET Get Artist's Albums
/artists/{id}/albums
Get Spotify catalog information about an artist's albums.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The Spotify ID of the artist. |
|
|
A comma-separated list of keywords that will be used to filter the response. If not supplied, all album types will be returned.
|
|
|
An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
|
|
|
The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50. |
|
|
The index of the first item to return. Default: 0 (the first item). Use with limit to get the next set of items. |
|
|
N/A |
GET Get Artist's Related Artists
/artists/{id}/related-artists
Get Spotify catalog information about artists similar to a given artist. Similarity is based on analysis of the Spotify community's listening history.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The Spotify ID of the artist. |
|
|
N/A |
GET Get Artist's Top Tracks
/artists/{id}/top-tracks
Get Spotify catalog information about an artist's top tracks by country.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The Spotify ID of the artist. |
|
|
An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
|
|
|
N/A |
GET Get Several Artists
/artists
Get Spotify catalog information for several artists based on their Spotify IDs.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
A comma-separated list of the Spotify IDs for the artists. Maximum: 50 IDs. |
|
|
N/A |
Audiobooks (7)
GET Check User's Saved Audiobooks
/me/audiobooks/contains
Check if one or more audiobooks are already saved in the current Spotify user's library.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
A comma-separated list of the Spotify IDs. For example: ids=4iV5W9uYEdYUVa79Axb7Rh,1301WleyT98MSxVHPZCA6M. Maximum: 50 IDs. |
|
|
N/A |
GET Get Audiobook Chapters
/audiobooks/{id}/chapters
Get Spotify catalog information about an audiobook's chapters.
Note: Audiobooks are only available for the US, UK, Ireland, New Zealand and Australia markets.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The Spotify ID
|
|
|
An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
|
|
|
The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50. |
|
|
The index of the first item to return. Default: 0 (the first item). Use with limit to get the next set of items. |
|
|
N/A |
GET Get Several Audiobooks
/audiobooks
Get Spotify catalog information for several audiobooks identified by their Spotify IDs.
Note: Audiobooks are only available for the US, UK, Ireland, New Zealand and Australia markets.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
A comma-separated list of the Spotify IDs. For example: ids=4iV5W9uYEdYUVa79Axb7Rh,1301WleyT98MSxVHPZCA6M. Maximum: 50 IDs. |
|
|
An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
|
|
|
N/A |
GET Get User's Saved Audiobooks
/me/audiobooks
Get a list of the audiobooks saved in the current Spotify user's 'Your Music' library.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50. |
|
|
The index of the first item to return. Default: 0 (the first item). Use with limit to get the next set of items. |
|
|
N/A |
GET Get an Audiobook
/audiobooks/{id}
Get Spotify catalog information for a single audiobook.
Note: Audiobooks are only available for the US, UK, Ireland, New Zealand and Australia markets.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The Spotify ID
|
|
|
An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
|
|
|
N/A |
DELETE Remove User's Saved Audiobooks
/me/audiobooks
Remove one or more audiobooks from the Spotify user's library.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
A comma-separated list of the Spotify IDs. For example: ids=4iV5W9uYEdYUVa79Axb7Rh,1301WleyT98MSxVHPZCA6M. Maximum: 50 IDs. |
|
|
N/A |
PUT Save Audiobooks for Current User
/me/audiobooks
Save one or more audiobooks to the current Spotify user's library.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
A comma-separated list of the Spotify IDs. For example: ids=4iV5W9uYEdYUVa79Axb7Rh,1301WleyT98MSxVHPZCA6M. Maximum: 50 IDs. |
|
|
N/A |
Categories (2)
GET Get Several Browse Categories
/browse/categories
Get a list of categories used to tag items in Spotify (on, for example, the Spotify player’s “Browse” tab).
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
A country: an ISO 3166-1 alpha-2 country code. Provide this parameter if you want to narrow the list of returned categories to those relevant to a particular country. If omitted, the returned items will be globally relevant. |
|
|
The desired language, consisting of an ISO 639-1 (http://en.wikipedia.org/wiki/ISO_639-1) language code and an ISO 3166-1 alpha-2 country code (http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), joined by an underscore. For example: es_MX, meaning "Spanish (Mexico)". Provide this parameter if you want the category metadata returned in a particular language.
|
|
|
The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50. |
|
|
The index of the first item to return. Default: 0 (the first item). Use with limit to get the next set of items. |
|
|
N/A |
GET Get Single Browse Category
/browse/categories/{category_id}
Get a single category used to tag items in Spotify (on, for example, the Spotify player’s “Browse” tab).
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The Spotify category ID for the category. |
|
|
A country: an ISO 3166-1 alpha-2 country code. Provide this parameter to ensure that the category exists for a particular country. |
|
|
The desired language, consisting of an ISO 639-1 (http://en.wikipedia.org/wiki/ISO_639-1) language code and an ISO 3166-1 alpha-2 country code (http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), joined by an underscore. For example: es_MX, meaning "Spanish (Mexico)". Provide this parameter if you want the category strings returned in a particular language. _Note: if locale is not supplied, or if the specified language is not available, the category strings returned will be in the Spotify default language (American English)._ |
|
|
N/A |
Chapters (2)
GET Get Several Chapters
/chapters
Get Spotify catalog information for several chapters identified by their Spotify IDs.
Note: Chapters are only available for the US, UK, Ireland, New Zealand and Australia markets.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
A comma-separated list of the Spotify IDs. For example: ids=4iV5W9uYEdYUVa79Axb7Rh,1301WleyT98MSxVHPZCA6M. Maximum: 50 IDs. |
|
|
An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
|
|
|
N/A |
GET Get a Chapter
/chapters/{id}
Get Spotify catalog information for a single chapter.
Note: Chapters are only available for the US, UK, Ireland, New Zealand and Australia markets.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The Spotify ID
|
|
|
An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
|
|
|
N/A |
Episodes (6)
GET Check User's Saved Episodes
/me/episodes/contains
Check if one or more episodes is already saved in the current Spotify user's 'Your Episodes' library.
This API endpoint is in __beta__ and could change without warning. Please share any feedback that you have, or issues that you discover, in our developer community forum..
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
A comma-separated list of the Spotify IDs for the episodes. Maximum: 50 IDs. |
|
|
N/A |
GET Get Episode
/episodes/{id}
Get Spotify catalog information for a single episode identified by its
unique Spotify ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The Spotify ID for the episode. |
|
|
An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
|
|
|
N/A |
GET Get Several Episodes
/episodes
Get Spotify catalog information for several episodes based on their Spotify IDs.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
A comma-separated list of the Spotify IDs for the episodes. Maximum: 50 IDs. |
|
|
An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
|
|
|
N/A |
GET Get User's Saved Episodes
/me/episodes
Get a list of the episodes saved in the current Spotify user's library.
This API endpoint is in __beta__ and could change without warning. Please share any feedback that you have, or issues that you discover, in our developer community forum.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
|
|
|
The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50. |
|
|
The index of the first item to return. Default: 0 (the first item). Use with limit to get the next set of items. |
|
|
N/A |
DELETE Remove User's Saved Episodes
/me/episodes
Remove one or more episodes from the current user's library.
This API endpoint is in __beta__ and could change without warning. Please share any feedback that you have, or issues that you discover, in our developer community forum.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
A comma-separated list of the Spotify IDs. For example: ids=4iV5W9uYEdYUVa79Axb7Rh,1301WleyT98MSxVHPZCA6M. Maximum: 50 IDs. |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
A JSON array of the Spotify IDs. A maximum of 50 items can be specified in one request. _Note: if the ids parameter is present in the query string, any IDs listed here in the body will be ignored._ |
PUT Save Episodes for Current User
/me/episodes
Save one or more episodes to the current user's library.
This API endpoint is in __beta__ and could change without warning. Please share any feedback that you have, or issues that you discover, in our developer community forum.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
A comma-separated list of the Spotify IDs. Maximum: 50 IDs. |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
A JSON array of the Spotify IDs. A maximum of 50 items can be specified in one request. _Note: if the ids parameter is present in the query string, any IDs listed here in the body will be ignored._ |
Genres
GET Get Available Genre Seeds
/recommendations/available-genre-seeds
Retrieve a list of available genres seed parameter values for recommendations.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Markets
GET Get Available Markets
/markets
Get the list of markets where Spotify is available.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Player (15)
POST Add Item to Playback Queue
/me/player/queue
Add an item to the end of the user's current playback queue.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The uri of the item to add to the queue. Must be a track or an episode uri. |
|
|
The id of the device this command is targeting. If
|
|
|
N/A |
GET Get Available Devices
/me/player/devices
Get information about a user’s available devices.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Currently Playing Track
/me/player/currently-playing
Get the object currently being played on the user's Spotify account.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
|
|
|
A comma-separated list of item types that your client supports besides the default track type. Valid types are: track and episode.
|
|
|
N/A |
GET Get Playback State
/me/player
Get information about the user’s current playback state, including track or episode, progress, and active device.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
|
|
|
A comma-separated list of item types that your client supports besides the default track type. Valid types are: track and episode.
|
|
|
N/A |
GET Get Recently Played Tracks
/me/player/recently-played
Get tracks from the current user's recently played tracks.
_Note: Currently doesn't support podcast episodes._
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50. |
|
|
A Unix timestamp in milliseconds. Returns all items
|
|
|
A Unix timestamp in milliseconds. Returns all items
|
|
|
N/A |
GET Get the User's Queue
/me/player/queue
Get the list of objects that make up the user's queue.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PUT Pause Playback
/me/player/pause
Pause playback on the user's account.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The id of the device this command is targeting. If not supplied, the user's currently active device is the target. |
|
|
N/A |
PUT Seek To Position
/me/player/seek
Seeks to the given position in the user’s currently playing track.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The position in milliseconds to seek to. Must be a
|
|
|
The id of the device this command is targeting. If
|
|
|
N/A |
PUT Set Playback Volume
/me/player/volume
Set the volume for the user’s current playback device.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The volume to set. Must be a value from 0 to 100 inclusive. |
|
|
The id of the device this command is targeting. If not supplied, the user's currently active device is the target. |
|
|
N/A |
PUT Set Repeat Mode
/me/player/repeat
Set the repeat mode for the user's playback. Options are repeat-track,
repeat-context, and off.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
track, context or off.
|
|
|
The id of the device this command is targeting. If
|
|
|
N/A |
POST Skip To Next
/me/player/next
Skips to next track in the user’s queue.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The id of the device this command is targeting. If not supplied, the user's currently active device is the target. |
|
|
N/A |
POST Skip To Previous
/me/player/previous
Skips to previous track in the user’s queue.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The id of the device this command is targeting. If
|
|
|
N/A |
PUT Start/Resume Playback
/me/player/play
Start a new context or resume current playback on the user's active device.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The id of the device this command is targeting. If not supplied, the user's currently active device is the target. |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Optional. Spotify URI of the context to play.
|
|
|
Optional. A JSON array of the Spotify track URIs to play.
|
|
|
Indicates from what position to start playback. Must be a positive number. Passing in a position that is greater than the length of the track will cause the player to start playing the next song. |
PUT Toggle Playback Shuffle
/me/player/shuffle
Toggle shuffle on or off for user’s playback.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
true : Shuffle user's playback.
|
|
|
The id of the device this command is targeting. If
|
|
|
N/A |
PUT Transfer Playback
/me/player
Transfer playback to a new device and determine if it should start playing.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
A JSON array containing the ID of the device on which playback should be started/transferred.For example:{device_ids:["74ASZWbe4lXaubB36ztrGX"]}_Note: Although an array is accepted, only a single device_id is currently supported. Supplying more than one will return 400 Bad Request_ |
|
|
true: ensure playback happens on new device.false or not provided: keep the current playback state. |
Playlists (13)
PUT Add Custom Playlist Cover Image
/playlists/{playlist_id}/images
Replace the image used to represent a specific playlist.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The Spotify ID of the playlist. |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Add Items to Playlist
/playlists/{playlist_id}/tracks
Add one or more items to a user's playlist.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The Spotify ID of the playlist. |
|
|
The position to insert the items, a zero-based index. For example, to insert the items in the first position: position=0; to insert the items in the third position: position=2. If omitted, the items will be appended to the playlist. Items are added in the order they are listed in the query string or request body. |
|
|
A comma-separated list of Spotify URIs to add, can be track or episode URIs. For example:uris=spotify:track:4iV5W9uYEdYUVa79Axb7Rh, spotify:track:1301WleyT98MSxVHPZCA6M, spotify:episode:512ojhOuo1ktJprKbVcKyQA maximum of 100 items can be added in one request.
|
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
A JSON array of the Spotify URIs to add. For example: {"uris": ["spotify:track:4iV5W9uYEdYUVa79Axb7Rh","spotify:track:1301WleyT98MSxVHPZCA6M", "spotify:episode:512ojhOuo1ktJprKbVcKyQ"]}A maximum of 100 items can be added in one request. _Note: if the uris parameter is present in the query string, any URIs listed here in the body will be ignored._ |
|
|
The position to insert the items, a zero-based index. For example, to insert the items in the first position: position=0 ; to insert the items in the third position: position=2. If omitted, the items will be appended to the playlist. Items are added in the order they appear in the uris array. For example: {"uris": ["spotify:track:4iV5W9uYEdYUVa79Axb7Rh","spotify:track:1301WleyT98MSxVHPZCA6M"], "position": 3} |
PUT Change Playlist Details
/playlists/{playlist_id}
Change a playlist's name and public/private state. (The user must, of
course, own the playlist.)
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The Spotify ID of the playlist. |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
The new name for the playlist, for example "My New Playlist Title" |
|
|
If true the playlist will be public, if false it will be private. |
|
|
If true, the playlist will become collaborative and other users will be able to modify the playlist in their Spotify client.
|
|
|
Value for playlist description as displayed in Spotify Clients and in the Web API. |
POST Create Playlist
/users/{user_id}/playlists
Create a playlist for a Spotify user. (The playlist will be empty until
you add tracks.)
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The user's Spotify user ID. |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
The name for the new playlist, for example "Your Coolest Playlist". This name does not need to be unique; a user may have several playlists with the same name. |
|
|
Defaults to true. If true the playlist will be public, if false it will be private. To be able to create private playlists, the user must have granted the playlist-modify-private scope |
|
|
Defaults to false. If true the playlist will be collaborative. _Note: to create a collaborative playlist you must also set public to false. To create collaborative playlists you must have granted playlist-modify-private and playlist-modify-public scopes._ |
|
|
value for playlist description as displayed in Spotify Clients and in the Web API. |
GET Get Category's Playlists
/browse/categories/{category_id}/playlists
Get a list of Spotify playlists tagged with a particular category.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The Spotify category ID for the category. |
|
|
A country: an ISO 3166-1 alpha-2 country code. Provide this parameter to ensure that the category exists for a particular country. |
|
|
The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50. |
|
|
The index of the first item to return. Default: 0 (the first item). Use with limit to get the next set of items. |
|
|
N/A |
GET Get Current User's Playlists
/me/playlists
Get a list of the playlists owned or followed by the current Spotify
user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50. |
|
|
'The index of the first playlist to return. Default:
|
|
|
N/A |
GET Get Featured Playlists
/browse/featured-playlists
Get a list of Spotify featured playlists (shown, for example, on a Spotify player's 'Browse' tab).
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
A country: an ISO 3166-1 alpha-2 country code. Provide this parameter if you want the list of returned items to be relevant to a particular country. If omitted, the returned items will be relevant to all countries. |
|
|
The desired language, consisting of a lowercase ISO 639-1 language code (http://en.wikipedia.org/wiki/ISO_639-1) and an uppercase ISO 3166-1 alpha-2 country code (http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), joined by an underscore. For example: es_MX, meaning "Spanish (Mexico)". Provide this parameter if you want the results returned in a particular language (where available).
|
|
|
A timestamp in ISO 8601 format: yyyy-MM-ddTHH:mm:ss. Use this parameter to specify the user's local time to get results tailored for that specific date and time in the day. If not provided, the response defaults to the current UTC time. Example: "2014-10-23T09:00:00" for a user whose local time is 9AM. If there were no featured playlists (or there is no data) at the specified time, the response will revert to the current UTC time. |
|
|
The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50. |
|
|
The index of the first item to return. Default: 0 (the first item). Use with limit to get the next set of items. |
|
|
N/A |
GET Get Playlist
/playlists/{playlist_id}
Get a playlist owned by a Spotify user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The Spotify ID of the playlist. |
|
|
An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
|
|
|
Filters for the query: a comma-separated list of the
|
|
|
A comma-separated list of item types that your client supports besides the default track type. Valid types are: track and episode.
|
|
|
N/A |
GET Get Playlist Cover Image
/playlists/{playlist_id}/images
Get the current image associated with a specific playlist.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The Spotify ID of the playlist. |
|
|
N/A |
GET Get Playlist Items
/playlists/{playlist_id}/tracks
Get full details of the items of a playlist owned by a Spotify user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The Spotify ID of the playlist. |
|
|
An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
|
|
|
Filters for the query: a comma-separated list of the
|
|
|
The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 100. |
|
|
The index of the first item to return. Default: 0 (the first item). Use with limit to get the next set of items. |
|
|
A comma-separated list of item types that your client supports besides the default track type. Valid types are: track and episode.
|
|
|
N/A |
GET Get User's Playlists
/users/{user_id}/playlists
Get a list of the playlists owned or followed by a Spotify user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The user's Spotify user ID. |
|
|
The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50. |
|
|
The index of the first playlist to return. Default:
|
|
|
N/A |
DELETE Remove Playlist Items
/playlists/{playlist_id}/tracks
Remove one or more items from a user's playlist.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The Spotify ID of the playlist. |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The playlist's snapshot ID against which you want to make the changes.
|
PUT Update Playlist Items
/playlists/{playlist_id}/tracks
Either reorder or replace items in a playlist depending on the request's parameters.
To reorder items, include range_start, insert_before, range_length and snapshot_id in the request's body.
To replace items, include uris as either a query parameter or in the request's body.
Replacing items in a playlist will overwrite its existing items. This operation can be used for replacing or clearing items in a playlist.
Note: Replace and reorder are mutually exclusive operations which share the same endpoint, but have different parameters.
These operations can't be applied together in a single request.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The Spotify ID of the playlist. |
|
|
A comma-separated list of Spotify URIs to set, can be track or episode URIs. For example: uris=spotify:track:4iV5W9uYEdYUVa79Axb7Rh,spotify:track:1301WleyT98MSxVHPZCA6M,spotify:episode:512ojhOuo1ktJprKbVcKyQA maximum of 100 items can be set in one request. |
|
|
N/A |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
The position of the first item to be reordered. |
|
|
The position where the items should be inserted.To reorder the items to the end of the playlist, simply set _insert_before_ to the position after the last item.Examples:To reorder the first item to the last position in a playlist with 10 items, set _range_start_ to 0, and _insert_before_ to 10.To reorder the last item in a playlist with 10 items to the start of the playlist, set _range_start_ to 9, and _insert_before_ to 0. |
|
|
The amount of items to be reordered. Defaults to 1 if not set.The range of items to be reordered begins from the _range_start_ position, and includes the _range_length_ subsequent items.Example:To move the items at index 9-10 to the start of the playlist, _range_start_ is set to 9, and _range_length_ is set to 2. |
|
|
The playlist's snapshot ID against which you want to make the changes. |
Search
GET Search for Item
/search
Get Spotify catalog information about albums, artists, playlists, tracks, shows, episodes or audiobooks
that match a keyword string.
Note: Audiobooks are only available for the US, UK, Ireland, New Zealand and Australia markets.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Your search query. You can narrow down your search using field filters. The available filters are album, artist, track, year, upc, tag:hipster, tag:new, isrc, and genre. Each field filter only applies to certain result types. The artist and year filters can be used while searching albums, artists and tracks. You can filter on a single year or a range (e.g. 1955-1960).
|
|
|
A comma-separated list of item types to search across. Search results include hits
|
|
|
An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
|
|
|
The maximum number of results to return in each item type. |
|
|
The index of the first result to return. Use
|
|
|
If include_external=audio is specified it signals that the client can play externally hosted audio content, and marks
|
|
|
N/A |
Shows (7)
GET Check User's Saved Shows
/me/shows/contains
Check if one or more shows is already saved in the current Spotify user's library.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
A comma-separated list of the Spotify IDs for the shows. Maximum: 50 IDs. |
|
|
N/A |
GET Get Several Shows
/shows
Get Spotify catalog information for several shows based on their Spotify IDs.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
|
|
|
A comma-separated list of the Spotify IDs for the shows. Maximum: 50 IDs. |
|
|
N/A |
GET Get Show
/shows/{id}
Get Spotify catalog information for a single show identified by its
unique Spotify ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
|
|
|
The Spotify ID
|
|
|
N/A |
GET Get Show Episodes
/shows/{id}/episodes
Get Spotify catalog information about an show’s episodes. Optional parameters can be used to limit the number of episodes returned.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The Spotify ID
|
|
|
An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
|
|
|
The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50. |
|
|
The index of the first item to return. Default: 0 (the first item). Use with limit to get the next set of items. |
|
|
N/A |
GET Get User's Saved Shows
/me/shows
Get a list of shows saved in the current Spotify user's library. Optional parameters can be used to limit the number of shows returned.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50. |
|
|
The index of the first item to return. Default: 0 (the first item). Use with limit to get the next set of items. |
|
|
N/A |
DELETE Remove User's Saved Shows
/me/shows
Delete one or more shows from current Spotify user's library.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
A comma-separated list of the Spotify IDs for the shows. Maximum: 50 IDs. |
|
|
An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
|
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
A JSON array of the Spotify IDs.
|
PUT Save Shows for Current User
/me/shows
Save one or more shows to current Spotify user's library.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
A comma-separated list of the Spotify IDs for the shows. Maximum: 50 IDs. |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
A JSON array of the Spotify IDs.
|
Tracks (10)
GET Check User's Saved Tracks
/me/tracks/contains
Check if one or more tracks is already saved in the current Spotify user's 'Your Music' library.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
A comma-separated list of the Spotify IDs. For example: ids=4iV5W9uYEdYUVa79Axb7Rh,1301WleyT98MSxVHPZCA6M. Maximum: 50 IDs. |
|
|
N/A |
GET Get Recommendations
/recommendations
Recommendations are generated based on the available information for a given seed entity and matched against similar artists and tracks. If there is sufficient information about the provided seeds, a list of tracks will be returned together with pool size details.
For artists and tracks that are very new or obscure there might not be enough data to generate a list of tracks.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The target size of the list of recommended tracks. For seeds with unusually small pools or when highly restrictive filtering is applied, it may be impossible to generate the requested number of recommended tracks. Debugging information for such cases is available in the response. Default: 20\. Minimum: 1\. Maximum: 100. |
|
|
An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
|
|
|
A comma separated list of Spotify IDs for seed artists. Up to 5 seed values may be provided in any combination of seed_artists, seed_tracks and seed_genres. |
|
|
A comma separated list of any genres in the set of available genre seeds. Up to 5 seed values may be provided in any combination of seed_artists, seed_tracks and seed_genres. |
|
|
A comma separated list of Spotify IDs for a seed track. Up to 5 seed values may be provided in any combination of seed_artists, seed_tracks and seed_genres. |
|
|
For each tunable track attribute, a hard floor on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, min_tempo=140 would restrict results to only those tracks with a tempo of greater than 140 beats per minute. |
|
|
For each tunable track attribute, a hard ceiling on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, max_instrumentalness=0.35 would filter out most tracks that are likely to be instrumental. |
|
|
For each of the tunable track attributes (below) a target value may be provided. Tracks with the attribute values nearest to the target values will be preferred. For example, you might request target_energy=0.6 and target_danceability=0.8. All target values will be weighed equally in ranking results. |
|
|
For each tunable track attribute, a hard floor on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, min_tempo=140 would restrict results to only those tracks with a tempo of greater than 140 beats per minute. |
|
|
For each tunable track attribute, a hard ceiling on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, max_instrumentalness=0.35 would filter out most tracks that are likely to be instrumental. |
|
|
For each of the tunable track attributes (below) a target value may be provided. Tracks with the attribute values nearest to the target values will be preferred. For example, you might request target_energy=0.6 and target_danceability=0.8. All target values will be weighed equally in ranking results. |
|
|
For each tunable track attribute, a hard floor on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, min_tempo=140 would restrict results to only those tracks with a tempo of greater than 140 beats per minute. |
|
|
For each tunable track attribute, a hard ceiling on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, max_instrumentalness=0.35 would filter out most tracks that are likely to be instrumental. |
|
|
Target duration of the track (ms) |
|
|
For each tunable track attribute, a hard floor on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, min_tempo=140 would restrict results to only those tracks with a tempo of greater than 140 beats per minute. |
|
|
For each tunable track attribute, a hard ceiling on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, max_instrumentalness=0.35 would filter out most tracks that are likely to be instrumental. |
|
|
For each of the tunable track attributes (below) a target value may be provided. Tracks with the attribute values nearest to the target values will be preferred. For example, you might request target_energy=0.6 and target_danceability=0.8. All target values will be weighed equally in ranking results. |
|
|
For each tunable track attribute, a hard floor on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, min_tempo=140 would restrict results to only those tracks with a tempo of greater than 140 beats per minute. |
|
|
For each tunable track attribute, a hard ceiling on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, max_instrumentalness=0.35 would filter out most tracks that are likely to be instrumental. |
|
|
For each of the tunable track attributes (below) a target value may be provided. Tracks with the attribute values nearest to the target values will be preferred. For example, you might request target_energy=0.6 and target_danceability=0.8. All target values will be weighed equally in ranking results. |
|
|
For each tunable track attribute, a hard floor on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, min_tempo=140 would restrict results to only those tracks with a tempo of greater than 140 beats per minute. |
|
|
For each tunable track attribute, a hard ceiling on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, max_instrumentalness=0.35 would filter out most tracks that are likely to be instrumental. |
|
|
For each of the tunable track attributes (below) a target value may be provided. Tracks with the attribute values nearest to the target values will be preferred. For example, you might request target_energy=0.6 and target_danceability=0.8. All target values will be weighed equally in ranking results. |
|
|
For each tunable track attribute, a hard floor on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, min_tempo=140 would restrict results to only those tracks with a tempo of greater than 140 beats per minute. |
|
|
For each tunable track attribute, a hard ceiling on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, max_instrumentalness=0.35 would filter out most tracks that are likely to be instrumental. |
|
|
For each of the tunable track attributes (below) a target value may be provided. Tracks with the attribute values nearest to the target values will be preferred. For example, you might request target_energy=0.6 and target_danceability=0.8. All target values will be weighed equally in ranking results. |
|
|
For each tunable track attribute, a hard floor on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, min_tempo=140 would restrict results to only those tracks with a tempo of greater than 140 beats per minute. |
|
|
For each tunable track attribute, a hard ceiling on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, max_instrumentalness=0.35 would filter out most tracks that are likely to be instrumental. |
|
|
For each of the tunable track attributes (below) a target value may be provided. Tracks with the attribute values nearest to the target values will be preferred. For example, you might request target_energy=0.6 and target_danceability=0.8. All target values will be weighed equally in ranking results. |
|
|
For each tunable track attribute, a hard floor on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, min_tempo=140 would restrict results to only those tracks with a tempo of greater than 140 beats per minute. |
|
|
For each tunable track attribute, a hard ceiling on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, max_instrumentalness=0.35 would filter out most tracks that are likely to be instrumental. |
|
|
For each of the tunable track attributes (below) a target value may be provided. Tracks with the attribute values nearest to the target values will be preferred. For example, you might request target_energy=0.6 and target_danceability=0.8. All target values will be weighed equally in ranking results. |
|
|
For each tunable track attribute, a hard floor on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, min_tempo=140 would restrict results to only those tracks with a tempo of greater than 140 beats per minute. |
|
|
For each tunable track attribute, a hard ceiling on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, max_instrumentalness=0.35 would filter out most tracks that are likely to be instrumental. |
|
|
For each of the tunable track attributes (below) a target value may be provided. Tracks with the attribute values nearest to the target values will be preferred. For example, you might request target_energy=0.6 and target_danceability=0.8. All target values will be weighed equally in ranking results. |
|
|
For each tunable track attribute, a hard floor on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, min_tempo=140 would restrict results to only those tracks with a tempo of greater than 140 beats per minute. |
|
|
For each tunable track attribute, a hard ceiling on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, max_instrumentalness=0.35 would filter out most tracks that are likely to be instrumental. |
|
|
For each of the tunable track attributes (below) a target value may be provided. Tracks with the attribute values nearest to the target values will be preferred. For example, you might request target_energy=0.6 and target_danceability=0.8. All target values will be weighed equally in ranking results. |
|
|
For each tunable track attribute, a hard floor on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, min_tempo=140 would restrict results to only those tracks with a tempo of greater than 140 beats per minute. |
|
|
For each tunable track attribute, a hard ceiling on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, max_instrumentalness=0.35 would filter out most tracks that are likely to be instrumental. |
|
|
Target tempo (BPM) |
|
|
For each tunable track attribute, a hard floor on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, min_tempo=140 would restrict results to only those tracks with a tempo of greater than 140 beats per minute. |
|
|
For each tunable track attribute, a hard ceiling on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, max_instrumentalness=0.35 would filter out most tracks that are likely to be instrumental. |
|
|
For each of the tunable track attributes (below) a target value may be provided. Tracks with the attribute values nearest to the target values will be preferred. For example, you might request target_energy=0.6 and target_danceability=0.8. All target values will be weighed equally in ranking results. |
|
|
For each tunable track attribute, a hard floor on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, min_tempo=140 would restrict results to only those tracks with a tempo of greater than 140 beats per minute. |
|
|
For each tunable track attribute, a hard ceiling on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, max_instrumentalness=0.35 would filter out most tracks that are likely to be instrumental. |
|
|
For each of the tunable track attributes (below) a target value may be provided. Tracks with the attribute values nearest to the target values will be preferred. For example, you might request target_energy=0.6 and target_danceability=0.8. All target values will be weighed equally in ranking results. |
|
|
N/A |
GET Get Several Tracks
/tracks
Get Spotify catalog information for multiple tracks based on their Spotify IDs.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
|
|
|
A comma-separated list of the Spotify IDs. For example: ids=4iV5W9uYEdYUVa79Axb7Rh,1301WleyT98MSxVHPZCA6M. Maximum: 50 IDs. |
|
|
N/A |
GET Get Track
/tracks/{id}
Get Spotify catalog information for a single track identified by its
unique Spotify ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The Spotify ID
|
|
|
An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
|
|
|
N/A |
GET Get Track's Audio Analysis
/audio-analysis/{id}
Get a low-level audio analysis for a track in the Spotify catalog. The audio analysis describes the track’s structure and musical content, including rhythm, pitch, and timbre.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The Spotify ID
|
|
|
N/A |
GET Get Track's Audio Features
/audio-features/{id}
Get audio feature information for a single track identified by its unique
Spotify ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The Spotify ID for the track. |
|
|
N/A |
GET Get Tracks' Audio Features
/audio-features
Get audio features for multiple tracks based on their Spotify IDs.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
A comma-separated list of the Spotify IDs
|
|
|
N/A |
GET Get User's Saved Tracks
/me/tracks
Get a list of the songs saved in the current Spotify user's 'Your Music' library.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
|
|
|
The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50. |
|
|
The index of the first item to return. Default: 0 (the first item). Use with limit to get the next set of items. |
|
|
N/A |
DELETE Remove User's Saved Tracks
/me/tracks
Remove one or more tracks from the current user's 'Your Music' library.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
A comma-separated list of the Spotify IDs. For example: ids=4iV5W9uYEdYUVa79Axb7Rh,1301WleyT98MSxVHPZCA6M. Maximum: 50 IDs. |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
A JSON array of the Spotify IDs. For example: ["4iV5W9uYEdYUVa79Axb7Rh", "1301WleyT98MSxVHPZCA6M"]A maximum of 50 items can be specified in one request. _Note: if the ids parameter is present in the query string, any IDs listed here in the body will be ignored._ |
PUT Save Tracks for Current User
/me/tracks
Save one or more tracks to the current user's 'Your Music' library.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
A comma-separated list of the Spotify IDs. For example: ids=4iV5W9uYEdYUVa79Axb7Rh,1301WleyT98MSxVHPZCA6M. Maximum: 50 IDs. |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
A JSON array of the Spotify IDs. For example: ["4iV5W9uYEdYUVa79Axb7Rh", "1301WleyT98MSxVHPZCA6M"]A maximum of 50 items can be specified in one request. _Note: if the ids parameter is present in the query string, any IDs listed here in the body will be ignored._ |
Users (11)
GET Check If User Follows Artists or Users
/me/following/contains
Check to see if the current user is following one or more artists or other Spotify users.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID type: either artist or user. |
|
|
A comma-separated list of the artist or the user Spotify IDs to check. For example: ids=74ASZWbe4lXaubB36ztrGX,08td7MxkoHQkXnWAYD8d6Q. A maximum of 50 IDs can be sent in one request. |
|
|
N/A |
GET Check if Users Follow Playlist
/playlists/{playlist_id}/followers/contains
Check to see if one or more Spotify users are following a specified playlist.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The Spotify ID of the playlist. |
|
|
A comma-separated list of Spotify User IDs ; the ids of the users that you want to check to see if they follow the playlist. Maximum: 5 ids. |
|
|
N/A |
PUT Follow Artists or Users
/me/following
Add the current user as a follower of one or more artists or other Spotify users.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID type. |
|
|
A comma-separated list of the artist or the user Spotify IDs.
|
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
A JSON array of the artist or user Spotify IDs.
|
PUT Follow Playlist
/playlists/{playlist_id}/followers
Add the current user as a follower of a playlist.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The Spotify ID of the playlist. |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Defaults to true. If true the playlist will be included in user's public playlists, if false it will remain private. |
GET Get Current User's Profile
/me
Get detailed profile information about the current user (including the
current user's username).
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Followed Artists
/me/following
Get the current user's followed artists.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID type: currently only artist is supported. |
|
|
The last artist ID retrieved from the previous request. |
|
|
The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50. |
|
|
N/A |
GET Get User's Profile
/users/{user_id}
Get public profile information about a Spotify user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The user's Spotify user ID. |
|
|
N/A |
GET Get User's Top Artists
/me/top/artists
Get the current user's top artists based on calculated affinity.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Over what time frame the affinities are computed. Valid values: long_term (calculated from several years of data and including all new data as it becomes available), medium_term (approximately last 6 months), short_term (approximately last 4 weeks). Default: medium_term |
|
|
The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50. |
|
|
The index of the first item to return. Default: 0 (the first item). Use with limit to get the next set of items. |
|
|
N/A |
GET Get User's Top Tracks
/me/top/tracks
Get the current user's top tracks based on calculated affinity.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Over what time frame the affinities are computed. Valid values: long_term (calculated from several years of data and including all new data as it becomes available), medium_term (approximately last 6 months), short_term (approximately last 4 weeks). Default: medium_term |
|
|
The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50. |
|
|
The index of the first item to return. Default: 0 (the first item). Use with limit to get the next set of items. |
|
|
N/A |
DELETE Unfollow Artists or Users
/me/following
Remove the current user as a follower of one or more artists or other Spotify users.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID type: either artist or user. |
|
|
A comma-separated list of the artist or the user Spotify IDs. For example: ids=74ASZWbe4lXaubB36ztrGX,08td7MxkoHQkXnWAYD8d6Q. A maximum of 50 IDs can be sent in one request. |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
A JSON array of the artist or user Spotify IDs. For example: {ids:["74ASZWbe4lXaubB36ztrGX", "08td7MxkoHQkXnWAYD8d6Q"]}. A maximum of 50 IDs can be sent in one request. _Note: if the ids parameter is present in the query string, any IDs listed here in the body will be ignored._ |
DELETE Unfollow Playlist
/playlists/{playlist_id}/followers
Remove the current user as a follower of a playlist.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The Spotify ID of the playlist. |
|
|
N/A |