Web API lets your applications fetch data from the Spotify music catalog and manage user’s playlists and saved music.
Datatype | Description | Example |
---|---|---|
Datepicker | String which includes date and time | |
Map | String which includes latitude and longitude coma separated | |
List | Simple array | |
Select | String with predefined values | |
Array | Array of objects |
Retrieve single album information
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
albumId | String | Id of the album |
market | String | An ISO 3166-1 alpha-2 country code. |
Retrieve several album information
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
albumIds | List | Id of the album |
market | String | An ISO 3166-1 alpha-2 country code. |
Retrieve single album tracks information
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
albumId | String | Id of the album |
limit | Number | The maximum number of tracks to return. Default: 20. Minimum: 1. Maximum: 50. |
offset | Number | The index of the first track to return. Default: 0 (the first object). Use with limit to get the next set of tracks. |
market | String | An ISO 3166-1 alpha-2 country code. |
Retrieve single artist information
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
artistId | String | Id of the artist |
Retrieve several artists information
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
artistIds | List | Ids of the artists |
Retrieve single artist albums information
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
artistId | String | Id of the artist |
albumTypes | List | Types of albums |
limit | Number | The maximum number of albums to return. Default: 20. Minimum: 1. Maximum: 50. |
offset | Number | The index of the first album to return. Default: 0 (the first object). Use with limit to get the next set of albums. |
market | String | An ISO 3166-1 alpha-2 country code. |
Retrieve single artist top tracksinformation
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
artistId | String | Id of the artis |
country | String | An ISO 3166-1 alpha-2 country code. |
Retrieve single artist related artists information
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
artistId | String | Id of the artis |
Get a list of Spotify featured playlists
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
limit | Number | The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50. |
offset | Number | The index of the first item to return. Default: 0 (the first object). Use with limit to get the next set of items. |
locale | String | The desired language, consisting of a lowercase ISO 639 language code and an uppercase ISO 3166-1 alpha-2 country code, joined by an underscore. |
country | String | An ISO 3166-1 alpha-2 country code. |
timestamp | DatePicker | A timestamp in ISO 8601 format: yyyy-MM-ddTHH:mm:ss |
Get a list of new album releases featured in Spotify
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
limit | Number | The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50. |
offset | Number | The index of the first item to return. Default: 0 (the first object). Use with limit to get the next set of items. |
country | String | An ISO 3166-1 alpha-2 country code. |
Get a list of categories used to tag items in Spotify
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
limit | Number | The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50. |
offset | Number | The index of the first item to return. Default: 0 (the first object). Use with limit to get the next set of items. |
locale | String | The desired language, consisting of a lowercase ISO 639 language code and an uppercase ISO 3166-1 alpha-2 country code, joined by an underscore. |
country | String | An ISO 3166-1 alpha-2 country code. |
Get a single category used to tag items in Spotify
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
categoryId | String | Id of the category |
locale | String | The desired language, consisting of a lowercase ISO 639 language code and an uppercase ISO 3166-1 alpha-2 country code, joined by an underscore. |
country | String | An ISO 3166-1 alpha-2 country code. |
Get a list of Spotify playlists tagged with a particular category.
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
categoryId | String | Id of the category |
country | String | An ISO 3166-1 alpha-2 country code. |
limit | Number | The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50. |
offset | Number | The index of the first item to return. Default: 0 (the first object). Use with limit to get the next set of items. |
Create a playlist-style listening experience based on seed artists, tracks and genres.
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
seedArtists | List | Id of the seed artists |
seedGenres | List | Id of the seed genres |
seedTracks | List | Id of the seed tracks |
limit | Number | The target size of the list of recommended tracks. |
market | String | An ISO 3166-1 alpha-2 country code. |
maxAcousticness | String | A confidence measure from 0.0 to 1.0 of whether the track is acoustic. |
minAcousticness | String | A confidence measure from 0.0 to 1.0 of whether the track is acoustic. |
targetAcousticness | String | A confidence measure from 0.0 to 1.0 of whether the track is acoustic. |
maxDanceability | String | Danceability describes how suitable a track is for dancing based on a combination of musical elements including tempo, rhythm stability, beat strength, and overall regularity. |
minDanceability | String | Danceability describes how suitable a track is for dancing based on a combination of musical elements including tempo, rhythm stability, beat strength, and overall regularity. |
targetDanceability | String | Danceability describes how suitable a track is for dancing based on a combination of musical elements including tempo, rhythm stability, beat strength, and overall regularity. |
maxDurationMs | Number | The duration of the track in milliseconds. |
minDurationMs | Number | The duration of the track in milliseconds. |
targetDurationMs | Number | The duration of the track in milliseconds. |
maxEnergy | String | Energy is a measure from 0.0 to 1.0 and represents a perceptual measure of intensity and activity. |
minEnergy | String | Energy is a measure from 0.0 to 1.0 and represents a perceptual measure of intensity and activity. |
targetEnergy | String | Energy is a measure from 0.0 to 1.0 and represents a perceptual measure of intensity and activity. |
maxInstrumentalness | String | Predicts whether a track contains no vocals. |
minInstrumentalness | String | Predicts whether a track contains no vocals. |
targetInstrumentalness | String | Predicts whether a track contains no vocals. |
maxKey | Number | The key the track is in. Integers map to pitches using standard Pitch Class notation. |
minKey | Number | The key the track is in. Integers map to pitches using standard Pitch Class notation. |
targetKey | Number | The key the track is in. Integers map to pitches using standard Pitch Class notation. |
maxLiveness | String | Detects the presence of an audience in the recording. |
minLiveness | String | Detects the presence of an audience in the recording. |
targetLiveness | String | Detects the presence of an audience in the recording. |
maxLoudness | String | The overall loudness of a track in decibels (dB). |
minLoudness | String | The overall loudness of a track in decibels (dB). |
targetLoudness | String | The overall loudness of a track in decibels (dB). |
mode | Select | Mode indicates the modality (major or minor) of a track, the type of scale from which its melodic content is derived. Major is represented by 1 and minor is 0. |
maxPopularity | Number | The popularity of the track. The value will be between 0 and 100, with 100 being the most popular. |
minPopularity | Number | The popularity of the track. The value will be between 0 and 100, with 100 being the most popular. |
targetPopularity | Number | The popularity of the track. The value will be between 0 and 100, with 100 being the most popular. |
maxSpeechiness | String | Speechiness detects the presence of spoken words in a track. The more exclusively speech-like the recording (e.g. talk show, audio book, poetry), the closer to 1.0 the attribute value. |
minSpeechiness | String | Speechiness detects the presence of spoken words in a track. The more exclusively speech-like the recording (e.g. talk show, audio book, poetry), the closer to 1.0 the attribute value. |
targetSpeechiness | String | Speechiness detects the presence of spoken words in a track. The more exclusively speech-like the recording (e.g. talk show, audio book, poetry), the closer to 1.0 the attribute value. |
maxTempo | String | The overall estimated tempo of a track in beats per minute (BPM). |
minTempo | String | The overall estimated tempo of a track in beats per minute (BPM). |
targetTempo | String | The overall estimated tempo of a track in beats per minute (BPM). |
maxTimeSignature | String | An estimated overall time signature of a track. |
minTimeSignature | String | An estimated overall time signature of a track. |
targetTimeSignature | String | An estimated overall time signature of a track. |
maxValence | String | A measure from 0.0 to 1.0 describing the musical positiveness conveyed by a track. |
minValence | String | A measure from 0.0 to 1.0 describing the musical positiveness conveyed by a track. |
targetValence | String | A measure from 0.0 to 1.0 describing the musical positiveness conveyed by a track. |
Get the current user’s followed artists
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
limit | Number | The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50. |
after | String | The last artist ID retrieved from the previous request. |
type | Select | The ID type: currently only artist is supported. |
Add the current user as a follower of one or more artists
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
artistIds | List | Id of the artist |
Add the current user as a follower of one or more Spotify users
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
userIds | List | Id of the user |
Rewmove the current user as a follower of one or more artists
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
artistIds | List | Id of the artist |
Remove the current user as a follower of one or more Spotify users
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
userIds | List | Id of the user |
Check to see if the current user is following one or more artists
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
artistIds | List | Id of the artist |
Add the current user as a follower of a playlist.
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
ownerId | String | The Spotify user ID of the person who owns the playlist. |
playlistId | String | The Spotify ID of the playlist. Any playlist can be followed, regardless of its public/private status, as long as you know its playlist ID |
public | Select | If true the playlist will be included in user’s public playlists, if false it will remain private. |
Remove the current user as a follower of a playlist.
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
ownerId | String | The Spotify user ID of the person who owns the playlist. |
playlistId | String | The Spotify ID of the playlist. |
Check to see if one or more Spotify users are following a specified playlist.
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
ownerId | String | The Spotify user ID of the person who owns the playlist. |
playlistId | String | The Spotify ID of the playlist. |
userIds | List | Id of the user |
Save one or more tracks to the current user’s “Your Music” library.
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
trackIds | List | Id of the track |
Get tracks from the current user’s “Your Music” library.
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
limit | Number | The maximum number of tracks to return. Default: 20. Minimum: 1. Maximum: 50. |
offset | Number | The index of the first track to return. Default: 0 (the first object). Use with limit to get the next set of tracks. |
market | String | An ISO 3166-1 alpha-2 country code. |
Remove one or more tracks from the current user’s “Your Music” library.
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
trackIds | List | Id of the track |
Check if one or more tracks is already saved in the current Spotify user’s “Your Music” library
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
trackIds | List | Id of the track |
Save one or more albums to the current user’s “Your Music” library.
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
albumIds | List | Id of the album |
Get albums from the current user’s “Your Music” library.
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
limit | Number | The maximum number of albums to return. Default: 20. Minimum: 1. Maximum: 50. |
offset | Number | The index of the first album to return. Default: 0 (the first object). Use with limit to get the next set of albums. |
market | String | An ISO 3166-1 alpha-2 country code. |
Delete one or more albums from the current user’s “Your Music” library.
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
albumIds | List | Id of the album |
Check if one or more albums is already saved in the current Spotify user’s “Your Music” library.
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
albumIds | List | Id of the album |
Get the current user’s top tracks based on calculated affinity.
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
limit | Number | The maximum number of tracks to return. Default: 20. Minimum: 1. Maximum: 50. |
offset | Number | The index of the first track to return. Default: 0 (the first object). Use with limit to get the next set of tracks. |
timeRange | Select | Over what time frame the affinities are computed. |
Get the current user’s top artists based on calculated affinity.
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
limit | Number | The maximum number of artists to return. Default: 20. Minimum: 1. Maximum: 50. |
offset | Number | The index of the first artist to return. Default: 0 (the first object). Use with limit to get the next set of artists. |
timeRange | Select | Over what time frame the affinities are computed. |
Get tracks from the current user’s recently played tracks.
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
limit | Number | The maximum number of tracks to return. Default: 20. Minimum: 1. Maximum: 50. |
after | DatePicker | Returns all items after (but not including) this cursor position. |
before | DatePicker | Returns all items before (but not including) this cursor position. |
Get information about a user’s available devices.
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
Get information about the user’s current playback state, including track, track progress, and active device.
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
market | String | An ISO 3166-1 alpha-2 country code. |
Get the object currently being played on the user’s Spotify account.
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
market | String | An ISO 3166-1 alpha-2 country code. |
Transfer playback to a new device and determine if it should start playing.
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
deviceIds | List | Id of the devices |
play | Select | Ensure playback happens or not on new device. |
Start a new context or resume current playback on the user’s active device.
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
deviceId | String | The id of the device this command is targeting. If not supplied, the user’s currently active device is the target. |
uris | List | uris |
contextUri | String | Spotify URI of the context to play. Valid contexts are albums, artists & playlists. |
offset | String | Indicates from where in the context playback should start |
Pause a new context or resume current playback on the user’s active device.
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
deviceId | String | The id of the device this command is targeting. If not supplied, the user’s currently active device is the target. |
Skips to next track in the user’s queue.
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
deviceId | String | The id of the device this command is targeting. If not supplied, the user’s currently active device is the target. |
Skips to previous track in the user’s queue.
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
deviceId | String | The id of the device this command is targeting. If not supplied, the user’s currently active device is the target. |
Seeks to the given position in the user’s currently playing track.
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
positionMs | Number | The position in milliseconds to seek to. |
deviceId | String | The id of the device this command is targeting. If not supplied, the user’s currently active device is the target. |
Set the repeat mode for the user’s playback. Options are repeat-track, repeat-context, and off.
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
state | Select | track will repeat the current track. context will repeat the current context. off will turn repeat off. |
deviceId | String | The id of the device this command is targeting. If not supplied, the user’s currently active device is the target. |
Set the volume for the user’s current playback device.
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
volumePercent | Number | The volume to set. Must be a value from 0 to 100 inclusive. |
deviceId | String | The id of the device this command is targeting. If not supplied, the user’s currently active device is the target. |
Toggle shuffle on or off for user’s playback.
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
state | Select | true: Shuffle user’s playback false: Do not shuffle user’s playback |
deviceId | String | The id of the device this command is targeting. If not supplied, the user’s currently active device is the target. |
Get a list of the playlists owned or followed by a Spotify user.
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
userId | String | The user’s Spotify user ID. |
limit | Number | The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50. |
offset | Number | The index of the first item to return. Default: 0 (the first object). |
Get a list of the playlists owned or followed by current Spotify user.
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
limit | Number | The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50. |
offset | Number | The index of the first item to return. Default: 0 (the first object). |
Get a playlist owned by a Spotify user.
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
userId | String | The user’s Spotify user ID. |
playlistId | String | Id of the playlist |
fields | List | Filters for the query: |
market | String | An ISO 3166-1 alpha-2 country code. |
Get full details of the tracks of a playlist owned by a Spotify user.
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
userId | String | The user’s Spotify user ID. |
playlistId | String | Id of the playlist |
fields | List | Filters for the query: |
market | String | An ISO 3166-1 alpha-2 country code. |
limit | Number | The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50. |
offset | Number | The index of the first item to return. Default: 0 (the first object). |
Create new playlist
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
userId | String | The user’s Spotify user ID. |
name | String | Name of the playlist |
public | Select | If true the playlist will be included in user’s public playlists, if false it will remain private. |
collaborative | Select | If true the playlist will be collaborative. |
description | String | Description of the playlist |
Add one or more tracks to a user’s playlist.
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
userId | String | The user’s Spotify user ID. |
playlistId | String | Id of the playlist |
uris | List | A list of Spotify track URIs to add. |
position | Number | The position to insert the tracks, a zero-based index |
Remove one or more tracks from a user’s playlist.
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
userId | String | The user’s Spotify user ID. |
playlistId | String | Id of the playlist |
tracks | List | A list of Spotify track URIs to remove. |
Reorder a track or a group of tracks in a playlist.
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
userId | String | The user’s Spotify user ID. |
playlistId | String | Id of the playlist |
rangeStart | Number | The position of the first track to be reordered. |
rangeLength | Number | The amount of tracks to be reordered. Defaults to 1 if not set. |
insertBefore | Number | The position where the tracks should be inserted. |
snapshotId | String | The playlist’s snapshot ID against which you want to make the changes. |
Replace all the tracks in a playlist, overwriting its existing tracks.
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
userId | String | The user’s Spotify user ID. |
playlistId | String | Id of the playlist |
uris | List | A list of Spotify track URIs to add. |
Change a playlist’s name and public/private state. .
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
userId | String | The user’s Spotify user ID. |
playlistId | String | Id of the playlist |
name | String | Name of the playlist |
public | Select | If true the playlist will be included in user’s public playlists, if false it will remain private. |
collaborative | Select | If true the playlist will be collaborative. |
description | String | Description of the playlist |
Get public profile information about a Spotify user.
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
userId | String | The user’s Spotify user ID. |
Get public profile information about current Spotify user.
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
Get Spotify catalog information about artists, albums, tracks or playlists that match a keyword string.
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
q | String | The search query’s keywords (and optional field filters and operators) |
type | List | A list of item types to search across. |
market | String | An ISO 3166-1 alpha-2 country code. |
limit | Number | The maximum number of item to return. Default: 20. Minimum: 1. Maximum: 50. |
offset | Number | The index of the first item to return. Default: 0 (the first object). Use with limit to get the next set of itemss. |
Retrieve single track information
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
trackId | String | Id of the track |
market | String | An ISO 3166-1 alpha-2 country code. |
Retrieve several tracks information
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
trackIds | List | Id of the tracks |
market | String | An ISO 3166-1 alpha-2 country code. |
Get a detailed audio analysis for a single track identified by its unique Spotify ID
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
trackId | String | Id of the track |
Get audio feature information for a single track identified by its unique Spotify ID.
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
trackId | String | Id of the track |
Get audio feature information for several tracks identified by its unique Spotify ID.
Field | Type | Description |
---|---|---|
accessToken | String | accessToken from user |
trackIds | List | Id of the tracks |