Skip to content

Me

Get Current User's Profile

me().retrieve(, ) : MeRetrieveResponse

GET/me

MeAudiobooks

Get User's Saved Audiobooks

me().audiobooks().list(, ) : AudiobookListPage

GET/me/audiobooks

Save Audiobooks for Current User

me().audiobooks().save(, )

PUT/me/audiobooks

Remove User's Saved Audiobooks

me().audiobooks().remove(, )

DELETE/me/audiobooks

Check User's Saved Audiobooks

me().audiobooks().check(, ) : List<Boolean>

GET/me/audiobooks/contains

MePlaylists

Get Current User's Playlists

me().playlists().list(, ) : PlaylistListPage

GET/me/playlists

MeTop

Get User's Top Tracks

me().top().listTopTracks(, ) : TopListTopTracksPage

GET/me/top/tracks

Get User's Top Artists

me().top().listTopArtists(, ) : TopListTopArtistsPage

GET/me/top/artists

MeAlbums

Get User's Saved Albums

me().albums().list(, ) : AlbumListPage

GET/me/albums

Save Albums for Current User

me().albums().save(, )

PUT/me/albums

Remove Users' Saved Albums

me().albums().remove(, )

DELETE/me/albums

Check User's Saved Albums

me().albums().check(, ) : List<Boolean>

GET/me/albums/contains

MeTracks

Get User's Saved Tracks

me().tracks().list(, ) : TrackListPage

GET/me/tracks

Save Tracks for Current User

me().tracks().save(, )

PUT/me/tracks

Remove User's Saved Tracks

me().tracks().remove(, )

DELETE/me/tracks

Check User's Saved Tracks

me().tracks().check(, ) : List<Boolean>

GET/me/tracks/contains

MeEpisodes

Get User's Saved Episodes

me().episodes().list(, ) : EpisodeListPage

GET/me/episodes

Save Episodes for Current User

me().episodes().save(, )

PUT/me/episodes

Remove User's Saved Episodes

me().episodes().remove(, )

DELETE/me/episodes

Check User's Saved Episodes

me().episodes().check(, ) : List<Boolean>

GET/me/episodes/contains

MeShows

Get User's Saved Shows

me().shows().list(, ) : ShowListPage

GET/me/shows

Save Shows for Current User

me().shows().save(, )

PUT/me/shows

Remove User's Saved Shows

me().shows().remove(, )

DELETE/me/shows

Check User's Saved Shows

me().shows().check(, ) : List<Boolean>

GET/me/shows/contains

MeFollowing

Get Followed Artists

me().following().bulkRetrieve(, ) : FollowingBulkRetrieveResponse

GET/me/following

Follow Artists or Users

me().following().follow(, )

PUT/me/following

Unfollow Artists or Users

me().following().unfollow(, )

DELETE/me/following

Check If User Follows Artists or Users

me().following().check(, ) : List<Boolean>

GET/me/following/contains

MePlayer

Get Playback State

me().player().getState(, ) : PlayerGetStateResponse

GET/me/player

Transfer Playback

me().player().transfer(, )

PUT/me/player

Get Available Devices

me().player().getDevices(, ) : PlayerGetDevicesResponse

GET/me/player/devices

Get Currently Playing Track

me().player().getCurrentlyPlaying(, ) : PlayerGetCurrentlyPlayingResponse

GET/me/player/currently-playing

Start/Resume Playback

me().player().startPlayback(, )

PUT/me/player/play

Pause Playback

me().player().pausePlayback(, )

PUT/me/player/pause

Skip To Next

me().player().skipNext(, )

POST/me/player/next

Skip To Previous

me().player().skipPrevious(, )

POST/me/player/previous

Seek To Position

me().player().seekToPosition(, )

PUT/me/player/seek

Set Repeat Mode

me().player().setRepeatMode(, )

PUT/me/player/repeat

Set Playback Volume

me().player().setVolume(, )

PUT/me/player/volume

Toggle Playback Shuffle

me().player().toggleShuffle(, )

PUT/me/player/shuffle

Get Recently Played Tracks

me().player().listRecentlyPlayed(, ) : PlayerListRecentlyPlayedPage

GET/me/player/recently-played

ModelsExpand Collapse

class ContextObject:

externalUrls: Optional<ExternalUrlObject>

External URLs for this context.

published: Optional<Boolean>

The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists

spotify: Optional<String>

The Spotify URL for the object.

href: Optional<String>

A link to the Web API endpoint providing full details of the track.

published: Optional<Boolean>

The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists

type: Optional<String>

The object type, e.g. "artist", "playlist", "album", "show".

uri: Optional<String>

The Spotify URI for the context.

class DeviceObject:

id: Optional<String>

The device ID. This ID is unique and persistent to some extent. However, this is not guaranteed and any cached device_id should periodically be cleared out and refetched as necessary.

isActive: Optional<Boolean>

If this device is the currently active device.

isPrivateSession: Optional<Boolean>

If this device is currently in a private session.

isRestricted: Optional<Boolean>

Whether controlling this device is restricted. At present if this is "true" then no Web API commands will be accepted by this device.

name: Optional<String>

A human-readable name for the device. Some devices have a name that the user can configure (e.g. "Loudest speaker") and some devices have a generic name associated with the manufacturer or device model.

published: Optional<Boolean>

The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists

supportsVolume: Optional<Boolean>

If this device can be used to set the volume.

type: Optional<String>

Device type, such as "computer", "smartphone" or "speaker".

volumePercent: Optional<Long>

The current volume in percent.

minimum0

maximum100

MePlayerQueue

Get the User's Queue

me().player().queue().get(, ) : QueueGetResponse

GET/me/player/queue

Add Item to Playback Queue

me().player().queue().add(, )

POST/me/player/queue