Spotifyconnector v1

Version 1

Connector Overview: This page documents all 89 actions for the Spotifyconnector v1.

View API Documentation

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Ids

A comma-separated list of the Spotify IDs for the albums. Maximum: 20 IDs.

Response Type

N/A

GET Get Album

/albums/{id}

Get Spotify catalog information for a single album.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

The Spotify ID of the album.

Market

An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
If a country code is specified, only content that is available in that market will be returned.
If a valid user access token is specified in the request header, the country associated with
the user account will take priority over this parameter.
_Note: If neither market or user country are provided, the content is considered unavailable for the client._
Users can view the country that is associated with their account in the account settings (https://www.spotify.com/se/account/overview/).

Response Type

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

The Spotify ID of the album.

Market

An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
If a country code is specified, only content that is available in that market will be returned.
If a valid user access token is specified in the request header, the country associated with
the user account will take priority over this parameter.
_Note: If neither market or user country are provided, the content is considered unavailable for the client._
Users can view the country that is associated with their account in the account settings (https://www.spotify.com/se/account/overview/).

Limit

The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.

Offset

The index of the first item to return. Default: 0 (the first item). Use with limit to get the next set of items.

Response Type

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Country

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.

Limit

The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.

Offset

The index of the first item to return. Default: 0 (the first item). Use with limit to get the next set of items.

Response Type

N/A

GET Get Several Albums

/albums

Get Spotify catalog information for multiple albums identified by their Spotify IDs.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Ids

A comma-separated list of the Spotify IDs for the albums. Maximum: 20 IDs.

Market

An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
If a country code is specified, only content that is available in that market will be returned.
If a valid user access token is specified in the request header, the country associated with
the user account will take priority over this parameter.
_Note: If neither market or user country are provided, the content is considered unavailable for the client._
Users can view the country that is associated with their account in the account settings (https://www.spotify.com/se/account/overview/).

Response Type

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Limit

The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.

Offset

The index of the first item to return. Default: 0 (the first item). Use with limit to get the next set of items.

Market

An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
If a country code is specified, only content that is available in that market will be returned.
If a valid user access token is specified in the request header, the country associated with
the user account will take priority over this parameter.
_Note: If neither market or user country are provided, the content is considered unavailable for the client._
Users can view the country that is associated with their account in the account settings (https://www.spotify.com/se/account/overview/).

Response Type

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

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Ids

A comma-separated list of the Spotify IDs for the albums. Maximum: 20 IDs.

Response Type

N/A

Options (1)

Option Name

Description

Ids

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

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Ids

A comma-separated list of the Spotify IDs for the albums. Maximum: 20 IDs.

Response Type

N/A

Options (1)

Option Name

Description

Ids

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

The Spotify ID of the artist.

Response Type

N/A

GET Get Artist's Albums

/artists/{id}/albums

Get Spotify catalog information about an artist's albums.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

The Spotify ID of the artist.

Include Groups

A comma-separated list of keywords that will be used to filter the response. If not supplied, all album types will be returned.
Valid values are:- album- single- appears_on- compilationFor example: include_groups=album,single.

Market

An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
If a country code is specified, only content that is available in that market will be returned.
If a valid user access token is specified in the request header, the country associated with
the user account will take priority over this parameter.
_Note: If neither market or user country are provided, the content is considered unavailable for the client._
Users can view the country that is associated with their account in the account settings (https://www.spotify.com/se/account/overview/).

Limit

The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.

Offset

The index of the first item to return. Default: 0 (the first item). Use with limit to get the next set of items.

Response Type

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

The Spotify ID of the artist.

Response Type

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

The Spotify ID of the artist.

Market

An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
If a country code is specified, only content that is available in that market will be returned.
If a valid user access token is specified in the request header, the country associated with
the user account will take priority over this parameter.
_Note: If neither market or user country are provided, the content is considered unavailable for the client._
Users can view the country that is associated with their account in the account settings (https://www.spotify.com/se/account/overview/).

Response Type

N/A

GET Get Several Artists

/artists

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

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Ids

A comma-separated list of the Spotify IDs for the artists. Maximum: 50 IDs.

Response Type

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Ids

A comma-separated list of the Spotify IDs. For example: ids=4iV5W9uYEdYUVa79Axb7Rh,1301WleyT98MSxVHPZCA6M. Maximum: 50 IDs.

Response Type

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

The Spotify ID
for the audiobook.

Market

An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
If a country code is specified, only content that is available in that market will be returned.
If a valid user access token is specified in the request header, the country associated with
the user account will take priority over this parameter.
_Note: If neither market or user country are provided, the content is considered unavailable for the client._
Users can view the country that is associated with their account in the account settings (https://www.spotify.com/se/account/overview/).

Limit

The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.

Offset

The index of the first item to return. Default: 0 (the first item). Use with limit to get the next set of items.

Response Type

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Ids

A comma-separated list of the Spotify IDs. For example: ids=4iV5W9uYEdYUVa79Axb7Rh,1301WleyT98MSxVHPZCA6M. Maximum: 50 IDs.

Market

An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
If a country code is specified, only content that is available in that market will be returned.
If a valid user access token is specified in the request header, the country associated with
the user account will take priority over this parameter.
_Note: If neither market or user country are provided, the content is considered unavailable for the client._
Users can view the country that is associated with their account in the account settings (https://www.spotify.com/se/account/overview/).

Response Type

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Limit

The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.

Offset

The index of the first item to return. Default: 0 (the first item). Use with limit to get the next set of items.

Response Type

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

The Spotify ID
for the audiobook.

Market

An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
If a country code is specified, only content that is available in that market will be returned.
If a valid user access token is specified in the request header, the country associated with
the user account will take priority over this parameter.
_Note: If neither market or user country are provided, the content is considered unavailable for the client._
Users can view the country that is associated with their account in the account settings (https://www.spotify.com/se/account/overview/).

Response Type

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Ids

A comma-separated list of the Spotify IDs. For example: ids=4iV5W9uYEdYUVa79Axb7Rh,1301WleyT98MSxVHPZCA6M. Maximum: 50 IDs.

Response Type

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Ids

A comma-separated list of the Spotify IDs. For example: ids=4iV5W9uYEdYUVa79Axb7Rh,1301WleyT98MSxVHPZCA6M. Maximum: 50 IDs.

Response Type

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Country

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.

Locale

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.
_Note: if locale is not supplied, or if the specified language is not available, all strings will be returned in the Spotify default language (American English). The locale parameter, combined with the country parameter, may give odd results if not carefully matched. For example country=SE&locale=de_DE will return a list of categories relevant to Sweden but as German language strings._

Limit

The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.

Offset

The index of the first item to return. Default: 0 (the first item). Use with limit to get the next set of items.

Response Type

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Category Id

The Spotify category ID for the category.

Country

A country: an ISO 3166-1 alpha-2 country code. Provide this parameter to ensure that the category exists for a particular country.

Locale

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

Response Type

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Ids

A comma-separated list of the Spotify IDs. For example: ids=4iV5W9uYEdYUVa79Axb7Rh,1301WleyT98MSxVHPZCA6M. Maximum: 50 IDs.

Market

An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
If a country code is specified, only content that is available in that market will be returned.
If a valid user access token is specified in the request header, the country associated with
the user account will take priority over this parameter.
_Note: If neither market or user country are provided, the content is considered unavailable for the client._
Users can view the country that is associated with their account in the account settings (https://www.spotify.com/se/account/overview/).

Response Type

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

The Spotify ID
for the chapter.

Market

An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
If a country code is specified, only content that is available in that market will be returned.
If a valid user access token is specified in the request header, the country associated with
the user account will take priority over this parameter.
_Note: If neither market or user country are provided, the content is considered unavailable for the client._
Users can view the country that is associated with their account in the account settings (https://www.spotify.com/se/account/overview/).

Response Type

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Ids

A comma-separated list of the Spotify IDs for the episodes. Maximum: 50 IDs.

Response Type

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

The Spotify ID for the episode.

Market

An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
If a country code is specified, only content that is available in that market will be returned.
If a valid user access token is specified in the request header, the country associated with
the user account will take priority over this parameter.
_Note: If neither market or user country are provided, the content is considered unavailable for the client._
Users can view the country that is associated with their account in the account settings (https://www.spotify.com/se/account/overview/).

Response Type

N/A

GET Get Several Episodes

/episodes

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

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Ids

A comma-separated list of the Spotify IDs for the episodes. Maximum: 50 IDs.

Market

An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
If a country code is specified, only content that is available in that market will be returned.
If a valid user access token is specified in the request header, the country associated with
the user account will take priority over this parameter.
_Note: If neither market or user country are provided, the content is considered unavailable for the client._
Users can view the country that is associated with their account in the account settings (https://www.spotify.com/se/account/overview/).

Response Type

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Market

An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
If a country code is specified, only content that is available in that market will be returned.
If a valid user access token is specified in the request header, the country associated with
the user account will take priority over this parameter.
_Note: If neither market or user country are provided, the content is considered unavailable for the client._
Users can view the country that is associated with their account in the account settings (https://www.spotify.com/se/account/overview/).

Limit

The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.

Offset

The index of the first item to return. Default: 0 (the first item). Use with limit to get the next set of items.

Response Type

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

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Ids

A comma-separated list of the Spotify IDs. For example: ids=4iV5W9uYEdYUVa79Axb7Rh,1301WleyT98MSxVHPZCA6M. Maximum: 50 IDs.

Response Type

N/A

Options (1)

Option Name

Description

Ids

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

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Ids

A comma-separated list of the Spotify IDs. Maximum: 50 IDs.

Response Type

N/A

Options (1)

Option Name

Description

Ids

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A

Markets

GET Get Available Markets

/markets

Get the list of markets where Spotify is available.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Uri

The uri of the item to add to the queue. Must be a track or an episode uri.

Device Id

The id of the device this command is targeting. If
not supplied, the user's currently active device is the target.

Response Type

N/A

GET Get Available Devices

/me/player/devices

Get information about a user’s available devices.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Market

An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
If a country code is specified, only content that is available in that market will be returned.
If a valid user access token is specified in the request header, the country associated with
the user account will take priority over this parameter.
_Note: If neither market or user country are provided, the content is considered unavailable for the client._
Users can view the country that is associated with their account in the account settings (https://www.spotify.com/se/account/overview/).

Additional Types

A comma-separated list of item types that your client supports besides the default track type. Valid types are: track and episode.
_Note: This parameter was introduced to allow existing clients to maintain their current behaviour and might be deprecated in the future._
In addition to providing this parameter, make sure that your client properly handles cases of new types in the future by checking against the type field of each object.

Response Type

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Market

An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
If a country code is specified, only content that is available in that market will be returned.
If a valid user access token is specified in the request header, the country associated with
the user account will take priority over this parameter.
_Note: If neither market or user country are provided, the content is considered unavailable for the client._
Users can view the country that is associated with their account in the account settings (https://www.spotify.com/se/account/overview/).

Additional Types

A comma-separated list of item types that your client supports besides the default track type. Valid types are: track and episode.
_Note: This parameter was introduced to allow existing clients to maintain their current behaviour and might be deprecated in the future._
In addition to providing this parameter, make sure that your client properly handles cases of new types in the future by checking against the type field of each object.

Response Type

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Limit

The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.

After

A Unix timestamp in milliseconds. Returns all items
after (but not including) this cursor position. If after is specified, before
must not be specified.

Before

A Unix timestamp in milliseconds. Returns all items
before (but not including) this cursor position. If before is specified,
after must not be specified.

Response Type

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A

PUT Pause Playback

/me/player/pause

Pause playback on the user's account.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Device Id

The id of the device this command is targeting. If not supplied, the user's currently active device is the target.

Response Type

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Position Ms

The position in milliseconds to seek to. 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.

Device Id

The id of the device this command is targeting. If
not supplied, the user's currently active device is the target.

Response Type

N/A

PUT Set Playback Volume

/me/player/volume

Set the volume for the user’s current playback device.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Volume Percent

The volume to set. Must be a value from 0 to 100 inclusive.

Device Id

The id of the device this command is targeting. If not supplied, the user's currently active device is the target.

Response Type

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

State

track, context or off.
track will repeat the current track.
context will repeat the current context.
off will turn repeat off.

Device Id

The id of the device this command is targeting. If
not supplied, the user's currently active device is the target.

Response Type

N/A

POST Skip To Next

/me/player/next

Skips to next track in the user’s queue.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Device Id

The id of the device this command is targeting. If not supplied, the user's currently active device is the target.

Response Type

N/A

POST Skip To Previous

/me/player/previous

Skips to previous track in the user’s queue.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Device Id

The id of the device this command is targeting. If
not supplied, the user's currently active device is the target.

Response Type

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

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Device Id

The id of the device this command is targeting. If not supplied, the user's currently active device is the target.

Response Type

N/A

Options (3)

Option Name

Description

Context Uri

Optional. Spotify URI of the context to play.
Valid contexts are albums, artists & playlists.
{context_uri:"spotify:album:1Je1IMUlBXcx1Fz0WE7oPT"}

Uris

Optional. A JSON array of the Spotify track URIs to play.
For example: {"uris": ["spotify:track:4iV5W9uYEdYUVa79Axb7Rh", "spotify:track:1301WleyT98MSxVHPZCA6M"]}

Position Ms

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

State

true : Shuffle user's playback.
false : Do not shuffle user's playback.

Device Id

The id of the device this command is targeting. If
not supplied, the user's currently active device is the target.

Response Type

N/A

PUT Transfer Playback

/me/player

Transfer playback to a new device and determine if it should start playing.

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A

Options (2)

Option Name

Description

Device Ids

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_

Play

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

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Playlist Id

The Spotify ID of the playlist.

Response Type

N/A

Options (1)

Option Name

Description

Options

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

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Playlist Id

The Spotify ID of the playlist.

Position

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.

Uris

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.
_Note: it is likely that passing a large number of item URIs as a query parameter will exceed the maximum length of the request URI. When adding a large number of items, it is recommended to pass them in the request body, see below._

Response Type

N/A

Options (2)

Option Name

Description

Uris

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

Position

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

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Playlist Id

The Spotify ID of the playlist.

Response Type

N/A

Options (4)

Option Name

Description

Name

The new name for the playlist, for example "My New Playlist Title"

Public

If true the playlist will be public, if false it will be private.

Collaborative

If true, the playlist will become collaborative and other users will be able to modify the playlist in their Spotify client.
_Note: You can only set collaborative to true on non-public playlists._

Description

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

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

User Id

The user's Spotify user ID.

Response Type

N/A

Options (4)

Option Name

Description

Name

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.

Public

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

Collaborative

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

Description

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Category Id

The Spotify category ID for the category.

Country

A country: an ISO 3166-1 alpha-2 country code. Provide this parameter to ensure that the category exists for a particular country.

Limit

The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.

Offset

The index of the first item to return. Default: 0 (the first item). Use with limit to get the next set of items.

Response Type

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Limit

The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.

Offset

'The index of the first playlist to return. Default:
0 (the first object). Maximum offset: 100.000\. Use with limit to get the
next set of playlists.'

Response Type

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Country

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.

Locale

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).
_Note: if locale is not supplied, or if the specified language is not available, all strings will be returned in the Spotify default language (American English). The locale parameter, combined with the country parameter, may give odd results if not carefully matched. For example country=SE&locale=de_DE will return a list of categories relevant to Sweden but as German language strings._

Timestamp

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.

Limit

The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.

Offset

The index of the first item to return. Default: 0 (the first item). Use with limit to get the next set of items.

Response Type

N/A

GET Get Playlist

/playlists/{playlist_id}

Get a playlist owned by a Spotify user.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Playlist Id

The Spotify ID of the playlist.

Market

An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
If a country code is specified, only content that is available in that market will be returned.
If a valid user access token is specified in the request header, the country associated with
the user account will take priority over this parameter.
_Note: If neither market or user country are provided, the content is considered unavailable for the client._
Users can view the country that is associated with their account in the account settings (https://www.spotify.com/se/account/overview/).

Fields

Filters for the query: a comma-separated list of the
fields to return. If omitted, all fields are returned. For example, to get
just the playlist''s description and URI: fields=description,uri. A dot
separator can be used to specify non-reoccurring fields, while parentheses
can be used to specify reoccurring fields within objects. For example, to
get just the added date and user ID of the adder: fields=tracks.items(added_at,added_by.id).
Use multiple parentheses to drill down into nested objects, for example: fields=tracks.items(track(name,href,album(name,href))).
Fields can be excluded by prefixing them with an exclamation mark, for example:
fields=tracks.items(track(name,href,album(!name,href)))

Additional Types

A comma-separated list of item types that your client supports besides the default track type. Valid types are: track and episode.
_Note: This parameter was introduced to allow existing clients to maintain their current behaviour and might be deprecated in the future._
In addition to providing this parameter, make sure that your client properly handles cases of new types in the future by checking against the type field of each object.

Response Type

N/A

GET Get Playlist Cover Image

/playlists/{playlist_id}/images

Get the current image associated with a specific playlist.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Playlist Id

The Spotify ID of the playlist.

Response Type

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Playlist Id

The Spotify ID of the playlist.

Market

An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
If a country code is specified, only content that is available in that market will be returned.
If a valid user access token is specified in the request header, the country associated with
the user account will take priority over this parameter.
_Note: If neither market or user country are provided, the content is considered unavailable for the client._
Users can view the country that is associated with their account in the account settings (https://www.spotify.com/se/account/overview/).

Fields

Filters for the query: a comma-separated list of the
fields to return. If omitted, all fields are returned. For example, to get
just the total number of items and the request limit:fields=total,limitA
dot separator can be used to specify non-reoccurring fields, while parentheses
can be used to specify reoccurring fields within objects. For example, to
get just the added date and user ID of the adder:fields=items(added_at,added_by.id)Use
multiple parentheses to drill down into nested objects, for example:fields=items(track(name,href,album(name,href)))Fields
can be excluded by prefixing them with an exclamation mark, for example:fields=items.track.album(!external_urls,images)

Limit

The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 100.

Offset

The index of the first item to return. Default: 0 (the first item). Use with limit to get the next set of items.

Additional Types

A comma-separated list of item types that your client supports besides the default track type. Valid types are: track and episode.
_Note: This parameter was introduced to allow existing clients to maintain their current behaviour and might be deprecated in the future._
In addition to providing this parameter, make sure that your client properly handles cases of new types in the future by checking against the type field of each object.

Response Type

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

User Id

The user's Spotify user ID.

Limit

The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.

Offset

The index of the first playlist to return. Default:
0 (the first object). Maximum offset: 100.000\. Use with limit to get the
next set of playlists.

Response Type

N/A

DELETE Remove Playlist Items

/playlists/{playlist_id}/tracks

Remove one or more items from a user's playlist.

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Playlist Id

The Spotify ID of the playlist.

Response Type

N/A

Options (1)

Option Name

Description

Snapshot Id

The playlist's snapshot ID against which you want to make the changes.
The API will validate that the specified items exist and in the specified positions and make the changes,
even if more recent changes have been made to the playlist.

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

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Playlist Id

The Spotify ID of the playlist.

Uris

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.

Response Type

N/A

Options (5)

Option Name

Description

Uris

N/A

Range Start

The position of the first item to be reordered.

Insert Before

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.

Range Length

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.

Snapshot Id

The playlist's snapshot ID against which you want to make the changes.

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Q

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).
The album filter can be used while searching albums and tracks.
The genre filter can be used while searching artists and tracks.
The isrc and track filters can be used while searching tracks.
The upc, tag:new and tag:hipster filters can only be used while searching albums. The tag:new filter will return albums released in the past two weeks and tag:hipster can be used to return only albums with the lowest 10% popularity.

Type

A comma-separated list of item types to search across. Search results include hits
from all the specified item types. For example: q=abacab&type=album,track returns
both albums and tracks matching "abacab".

Market

An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
If a country code is specified, only content that is available in that market will be returned.
If a valid user access token is specified in the request header, the country associated with
the user account will take priority over this parameter.
_Note: If neither market or user country are provided, the content is considered unavailable for the client._
Users can view the country that is associated with their account in the account settings (https://www.spotify.com/se/account/overview/).

Limit

The maximum number of results to return in each item type.

Offset

The index of the first result to return. Use
with limit to get the next page of search results.

Include External

If include_external=audio is specified it signals that the client can play externally hosted audio content, and marks
the content as playable in the response. By default externally hosted audio content is marked as unplayable in the response.

Response Type

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Ids

A comma-separated list of the Spotify IDs for the shows. Maximum: 50 IDs.

Response Type

N/A

GET Get Several Shows

/shows

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

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Market

An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
If a country code is specified, only content that is available in that market will be returned.
If a valid user access token is specified in the request header, the country associated with
the user account will take priority over this parameter.
_Note: If neither market or user country are provided, the content is considered unavailable for the client._
Users can view the country that is associated with their account in the account settings (https://www.spotify.com/se/account/overview/).

Ids

A comma-separated list of the Spotify IDs for the shows. Maximum: 50 IDs.

Response Type

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Market

An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
If a country code is specified, only content that is available in that market will be returned.
If a valid user access token is specified in the request header, the country associated with
the user account will take priority over this parameter.
_Note: If neither market or user country are provided, the content is considered unavailable for the client._
Users can view the country that is associated with their account in the account settings (https://www.spotify.com/se/account/overview/).

Id

The Spotify ID
for the show.

Response Type

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

The Spotify ID
for the show.

Market

An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
If a country code is specified, only content that is available in that market will be returned.
If a valid user access token is specified in the request header, the country associated with
the user account will take priority over this parameter.
_Note: If neither market or user country are provided, the content is considered unavailable for the client._
Users can view the country that is associated with their account in the account settings (https://www.spotify.com/se/account/overview/).

Limit

The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.

Offset

The index of the first item to return. Default: 0 (the first item). Use with limit to get the next set of items.

Response Type

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Limit

The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.

Offset

The index of the first item to return. Default: 0 (the first item). Use with limit to get the next set of items.

Response Type

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

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Ids

A comma-separated list of the Spotify IDs for the shows. Maximum: 50 IDs.

Market

An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
If a country code is specified, only content that is available in that market will be returned.
If a valid user access token is specified in the request header, the country associated with
the user account will take priority over this parameter.
_Note: If neither market or user country are provided, the content is considered unavailable for the client._
Users can view the country that is associated with their account in the account settings (https://www.spotify.com/se/account/overview/).

Response Type

N/A

Options (1)

Option Name

Description

Ids

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 Shows for Current User

/me/shows

Save one or more shows to current Spotify user's library.

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Ids

A comma-separated list of the Spotify IDs for the shows. Maximum: 50 IDs.

Response Type

N/A

Options (1)

Option Name

Description

Ids

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.

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Ids

A comma-separated list of the Spotify IDs. For example: ids=4iV5W9uYEdYUVa79Axb7Rh,1301WleyT98MSxVHPZCA6M. Maximum: 50 IDs.

Response Type

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Limit

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.

Market

An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
If a country code is specified, only content that is available in that market will be returned.
If a valid user access token is specified in the request header, the country associated with
the user account will take priority over this parameter.
_Note: If neither market or user country are provided, the content is considered unavailable for the client._
Users can view the country that is associated with their account in the account settings (https://www.spotify.com/se/account/overview/).

Seed Artists

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.

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.

Seed Tracks

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.

Min Acousticness

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.

Max Acousticness

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 Acousticness

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.

Min Danceability

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.

Max Danceability

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 Danceability

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.

Min Duration 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.

Max Duration Ms

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 Ms

Target duration of the track (ms)

Min Energy

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.

Max Energy

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 Energy

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.

Min Instrumentalness

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.

Max Instrumentalness

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 Instrumentalness

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.

Min Key

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.

Max Key

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 Key

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.

Min Liveness

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.

Max Liveness

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 Liveness

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.

Min Loudness

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.

Max Loudness

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 Loudness

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.

Min Mode

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.

Max Mode

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 Mode

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.

Min Popularity

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.

Max Popularity

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 Popularity

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.

Min Speechiness

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.

Max Speechiness

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 Speechiness

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.

Min Tempo

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.

Max Tempo

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

Target tempo (BPM)

Min Time Signature

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.

Max Time Signature

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

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.

Min Valence

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.

Max Valence

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 Valence

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.

Response Type

N/A

GET Get Several Tracks

/tracks

Get Spotify catalog information for multiple tracks based on their Spotify IDs.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Market

An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
If a country code is specified, only content that is available in that market will be returned.
If a valid user access token is specified in the request header, the country associated with
the user account will take priority over this parameter.
_Note: If neither market or user country are provided, the content is considered unavailable for the client._
Users can view the country that is associated with their account in the account settings (https://www.spotify.com/se/account/overview/).

Ids

A comma-separated list of the Spotify IDs. For example: ids=4iV5W9uYEdYUVa79Axb7Rh,1301WleyT98MSxVHPZCA6M. Maximum: 50 IDs.

Response Type

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

The Spotify ID
for the track.

Market

An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
If a country code is specified, only content that is available in that market will be returned.
If a valid user access token is specified in the request header, the country associated with
the user account will take priority over this parameter.
_Note: If neither market or user country are provided, the content is considered unavailable for the client._
Users can view the country that is associated with their account in the account settings (https://www.spotify.com/se/account/overview/).

Response Type

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

The Spotify ID
for the track.

Response Type

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

The Spotify ID for the track.

Response Type

N/A

GET Get Tracks' Audio Features

/audio-features

Get audio features for multiple tracks based on their Spotify IDs.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Ids

A comma-separated list of the Spotify IDs
for the tracks. Maximum: 100 IDs.

Response Type

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Market

An ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
If a country code is specified, only content that is available in that market will be returned.
If a valid user access token is specified in the request header, the country associated with
the user account will take priority over this parameter.
_Note: If neither market or user country are provided, the content is considered unavailable for the client._
Users can view the country that is associated with their account in the account settings (https://www.spotify.com/se/account/overview/).

Limit

The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.

Offset

The index of the first item to return. Default: 0 (the first item). Use with limit to get the next set of items.

Response Type

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

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Ids

A comma-separated list of the Spotify IDs. For example: ids=4iV5W9uYEdYUVa79Axb7Rh,1301WleyT98MSxVHPZCA6M. Maximum: 50 IDs.

Response Type

N/A

Options (1)

Option Name

Description

Ids

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

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Ids

A comma-separated list of the Spotify IDs. For example: ids=4iV5W9uYEdYUVa79Axb7Rh,1301WleyT98MSxVHPZCA6M. Maximum: 50 IDs.

Response Type

N/A

Options (1)

Option Name

Description

Ids

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Type

The ID type: either artist or user.

Ids

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.

Response Type

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Playlist Id

The Spotify ID of the playlist.

Ids

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.

Response Type

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

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Type

The ID type.

Ids

A comma-separated list of the artist or the user Spotify IDs.
A maximum of 50 IDs can be sent in one request.

Response Type

N/A

Options (1)

Option Name

Description

Ids

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

PUT Follow Playlist

/playlists/{playlist_id}/followers

Add the current user as a follower of a playlist.

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Playlist Id

The Spotify ID of the playlist.

Response Type

N/A

Options (1)

Option Name

Description

Public

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A

GET Get Followed Artists

/me/following

Get the current user's followed artists.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Type

The ID type: currently only artist is supported.

After

The last artist ID retrieved from the previous request.

Limit

The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.

Response Type

N/A

GET Get User's Profile

/users/{user_id}

Get public profile information about a Spotify user.

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

User Id

The user's Spotify user ID.

Response Type

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Time Range

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

Limit

The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.

Offset

The index of the first item to return. Default: 0 (the first item). Use with limit to get the next set of items.

Response Type

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Time Range

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

Limit

The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.

Offset

The index of the first item to return. Default: 0 (the first item). Use with limit to get the next set of items.

Response Type

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

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Type

The ID type: either artist or user.

Ids

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.

Response Type

N/A

Options (1)

Option Name

Description

Ids

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

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Playlist Id

The Spotify ID of the playlist.

Response Type

N/A