Icon

Spotify (version v1.*.*)

add_track_to_playlist

Add Tracks to a Playlist

Parameters

playlist_id (required)

The Spotify playlist ID.

Type: string

uris (required)

A comma-separated list of Spotify track URIs to add. A maximum of 100 tracks can be added in one request.

Type: string

user_id (required)

The user's Spotify user ID.

Type: string

position

The position to insert the tracks, a zero-based index

Type: integer

Get a List of Featured Playlists

Parameters

country

The country (an ISO 3166-1 alpha-2 country code)

Type: string

locale

The desired language, consisting of an ISO 639 language code and an ISO 3166-1 alpha-2 country code, joined by an underscore. For example: es_MX, meaning "Spanish (Mexico)".

Type: string

timestamp

A timestamp in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss) with the user's local time to get results tailored to a specific date and time in the day. If not provided, it defaults to the current UTC time. Example: "2014-10-23T09:00:00" for a user whose local time is 9AM.

Type: string

browse_new_releases

Get a List of New Releases

Parameters

country

The country (an ISO 3166-1 alpha-2 country code)

Type: string

check_if_i_am_following

Check if Current User Follows Artists or Users

Parameters

ids (required)

A comma-separated string of the artists or users ids.

Type: string

type (required)

The type to follow.

Type: string

Potential values: artist, user

check_my_saved_tracks

Check Current User's Saved Tracks

Parameters

ids (required)

A comma-separated list of IDs

Type: string

check_playlist_followers

Check if Users Follow a Playlist

Parameters

ids (required)

A comma-separated list of users ids

Type: string

owner_id (required)

The playlist owner's Spotify ID

Type: string

playlist_id (required)

The Spotify playlist ID.

Type: string

create_playlist

Create a Playlist

Parameters

user_id (required)

The user's Spotify user ID.

Type: string

$body

Type: object

{
"public" : "boolean",
"name" : "Required string"
}

delete_my_track

Remove Tracks for Current User

Parameters

ids (required)

A comma-separated list of IDs

Type: string

edit_playlist_details

Change a Playlist's Details

Parameters

playlist_id (required)

The Spotify playlist ID.

Type: string

user_id (required)

The user's Spotify user ID.

Type: string

$body

Type: object

{
"public" : "boolean",
"name" : "string"
}

follow

Follow Artists or Users

Parameters

ids (required)

A comma-separated list of the artists or users ids

Type: string

type (required)

The type to follow.

Type: string

Potential values: artist, user

follow_playlist

Follow a Playlist

Parameters

playlist_id (required)

The Spotify playlist ID.

Type: string

user_id (required)

The user's Spotify user ID.

Type: string

$body

Type: object

{
"public" : "boolean"
}

get_album

Get an Album

Parameters

id (required)

The Spotify ID for the album

Type: string

market

The market (an ISO 3166-1 alpha-2 country code)

Type: string

get_album_tracks

Get an Album's Tracks

Parameters

id (required)

The Spotify ID for the album

Type: string

market

The market (an ISO 3166-1 alpha-2 country code)

Type: string

get_albums

Get Several Albums

Parameters

ids (required)

A comma-separated list of IDs

Type: string

market

The market (an ISO 3166-1 alpha-2 country code)

Type: string

get_artist

Get an Artist

Parameters

id (required)

The Spotify ID for the artist

Type: string

get_artist_albums

Get an Artist's Albums

Parameters

id (required)

The Spotify ID for the artist

Type: string

album_type

Filter by album types

Type: string

market

The market (an ISO 3166-1 alpha-2 country code)

Type: string

get_artist_top_tracks

Get an Artist's Top Tracks

Parameters

country (required)

The country (an ISO 3166-1 alpha-2 country code)

Type: string

id (required)

The Spotify ID for the artist

Type: string

get_artists

Get Several Artists

Parameters

ids (required)

A comma-separated list of IDs

Type: string

get_artists_i_am_following

Get User's Followed Artists

Parameters

type (required)

The ID type, currently only artist is supported.

Type: string

Potential values: artist

get_browse_categories

Get a List of Browse Categories

Parameters

country

The country (an ISO 3166-1 alpha-2 country code)

Type: string

locale

The desired language, consisting of an ISO 639 language code and an ISO 3166-1 alpha-2 country code, joined by an underscore. For example: es_MX, meaning "Spanish (Mexico)".

Type: string

get_browse_category

Get a Single Browse Category

Parameters

category_id (required)

The Spotify ID of the category you wish to fetch.

Type: string

country

The country (an ISO 3166-1 alpha-2 country code)

Type: string

locale

The desired language, consisting of an ISO 639 language code and an ISO 3166-1 alpha-2 country code, joined by an underscore. For example: es_MX, meaning "Spanish (Mexico)".

Type: string

get_category_playlists

Get a Category's playlists

Parameters

category_id (required)

The Spotify ID of the category you wish to fetch.

Type: string

country

The country (an ISO 3166-1 alpha-2 country code)

Type: string

get_my_playlists

Get a List of Current User's Playlists

This operation has no parameters

get_my_profile

This operation has no parameters

get_my_saved_tracks

Get Current User's Saved Tracks

Parameters

market

The market (an ISO 3166-1 alpha-2 country code)

Type: string

get_playlist

Get a Playlist

Parameters

playlist_id (required)

The Spotify playlist ID.

Type: string

user_id (required)

The user's Spotify user ID.

Type: string

fields

A comma-separated list of fields to filter query

Type: string

market

The market (an ISO 3166-1 alpha-2 country code)

Type: string

get_playlist_tracks

Get a Playlist's Tracks

Parameters

playlist_id (required)

The Spotify playlist ID.

Type: string

user_id (required)

The user's Spotify user ID.

Type: string

fields

A comma-separated list of fields to filter query

Type: string

market

The market (an ISO 3166-1 alpha-2 country code)

Type: string

Get an Artist's Related Artists

Parameters

id (required)

The Spotify ID for the artist

Type: string

get_track

Get a Track

Parameters

id (required)

Type: string

market

The market (an ISO 3166-1 alpha-2 country code)

Type: string

get_tracks

Get Several Tracks

Parameters

ids (required)

A comma-separated list of IDs

Type: string

market

The market (an ISO 3166-1 alpha-2 country code)

Type: string

get_user

Get a User's Profile

Parameters

user_id (required)

The user's Spotify user ID.

Type: string

get_user_playlists

Get a List of a User's Playlists

Parameters

user_id (required)

The user's Spotify user ID.

Type: string

player

This operation has no parameters

player_currently_playing

This operation has no parameters

player_pause

This operation has no parameters

player_play

Start/Resume a User's Playback

Parameters

$body

Type: object

{
"uris" : [ "string" ],
"position_ms" : "integer",
"offset" : {
"position" : "integer",
"uri" : "string"
},
"context_uri" : "string"
}

player_seek

Seek To Position In Currently Playing Track

Parameters

position_ms (required)

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.

Type: integer

remove_playlist_tracks

Remove Tracks from a Playlist

Parameters

playlist_id (required)

The Spotify playlist ID.

Type: string

user_id (required)

The user's Spotify user ID.

Type: string

$body

Type: object

{
"tracks" : [ {
"uri" : "string"
} ]
}

reorder_playlist_tracks

Reorder or replace a Playlist's Tracks

Parameters

playlist_id (required)

The Spotify playlist ID.

Type: string

user_id (required)

The user's Spotify user ID.

Type: string

$body

Type: object

{
"insert_before" : "Required. The position where the tracks should be inserted. To reorder the tracks to the end of the playlist, simply set insert_before to the position after the last track. Examples- To reorder the first track to the last position in a playlist with 10 tracks, set range_start to 0, and insert_before to 10. To reorder the last track in a playlist with 10 tracks to the start of the playlist, set range_start to 9, and insert_before to 0.",
"snapshot_id" : "Optional. The playlist’s snapshot ID against which you want to make the changes.",
"range_length" : "Optional. The amount of tracks to be reordered. Defaults to 1 if not set. \\ The range of tracks to be reordered begins from the range_start position, and includes the range_length subsequent tracks. Example - To move the tracks at index 9-10 to the start of the playlist, range_start is set to 9, and range_length is set to 2.",
"range_start" : "Required. The position of the first track to be reordered."
}

save_track

Save Tracks for Current User

Parameters

ids (required)

A comma-separated list of IDs

Type: string

Search for an Item

Parameters

q (required)

The search query's keywords (and optional field filters). The search is not case-sensitive: 'roadhouse' will match 'Roadhouse', 'roadHouse', etc. Keywords will be matched in any order unless surrounded by quotes, thus q=roadhouse&20blues will match both 'Blues Roadhouse' and 'Roadhouse of the Blues'. Quotation marks can be used to limit the match to a phrase: q=roadhouse&20blues will match 'My Roadhouse Blues' but not 'Roadhouse of the Blues'. By default, results are returned when a match is found in any field of the target object type. Searches can be made more specific by specifying an album, artist or track field filter. For example q=album:gold%20artist:abba&type=album will search for albums with the text 'gold' in the album name and the text 'abba' in an artist name. Other possible field filters, depending on object types being searched, include year, genre, upc, and isrc. For example, q=damian%20genre:reggae-pop&type=artist. The asterisk (*) character can, with some limitations, be used as a wildcard (maximum: 2 per query). It will match a variable number of non-white-space characters. It cannot be used in a quoted phrase, in a field filter, or as the first character of the keyword string. Searching for playlists will return results matching the playlist's name and/or description.

Type: string

type (required)

A comma-separated list of item types to search across. Search results will include hits from all the specified item types; for example q=name:abacab&type=album,track will return both albums and tracks with "abacab" in their name.

Type: string

market

The market (an ISO 3166-1 alpha-2 country code). If given, only items with content playable in that market will be returned.

Type: string

unfollow

Unfollow Artists or Users

Parameters

ids (required)

A comma-separated list of the artists or users ids

Type: string

type (required)

The type to unfollow.

Type: string

Potential values: artist, user

unfollow_playlist

Unfollow a Playlist

Parameters

playlist_id (required)

The Spotify playlist ID.

Type: string

user_id (required)

The user's Spotify user ID.

Type: string