Skip to content
DocumentationAPI Reference

Me

Get Current User's Profile
MeRetrieveResponse me().retrieve(MeRetrieveParamsparams = MeRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/me

MeAudiobooks

Get User's Saved Audiobooks
AudiobookListPage me().audiobooks().list(AudiobookListParamsparams = AudiobookListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/me/audiobooks
Save Audiobooks for Current User
me().audiobooks().save(AudiobookSaveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
PUT/me/audiobooks
Remove User's Saved Audiobooks
me().audiobooks().remove(AudiobookRemoveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
DELETE/me/audiobooks
Check User's Saved Audiobooks
List<boolean> me().audiobooks().check(AudiobookCheckParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
GET/me/audiobooks/contains

MePlaylists

Get Current User's Playlists
PlaylistListPage me().playlists().list(PlaylistListParamsparams = PlaylistListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/me/playlists

MeTop

Get User's Top Tracks
TopListTopTracksPage me().top().listTopTracks(TopListTopTracksParamsparams = TopListTopTracksParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/me/top/tracks
Get User's Top Artists
TopListTopArtistsPage me().top().listTopArtists(TopListTopArtistsParamsparams = TopListTopArtistsParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/me/top/artists

MeAlbums

Get User's Saved Albums
AlbumListPage me().albums().list(AlbumListParamsparams = AlbumListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/me/albums
Save Albums for Current User
me().albums().save(AlbumSaveParamsparams = AlbumSaveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
PUT/me/albums
Remove Users' Saved Albums
me().albums().remove(AlbumRemoveParamsparams = AlbumRemoveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
DELETE/me/albums
Check User's Saved Albums
List<boolean> me().albums().check(AlbumCheckParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
GET/me/albums/contains

MeTracks

Get User's Saved Tracks
TrackListPage me().tracks().list(TrackListParamsparams = TrackListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/me/tracks
Save Tracks for Current User
me().tracks().save(TrackSaveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
PUT/me/tracks
Remove User's Saved Tracks
me().tracks().remove(TrackRemoveParamsparams = TrackRemoveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
DELETE/me/tracks
Check User's Saved Tracks
List<boolean> me().tracks().check(TrackCheckParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
GET/me/tracks/contains

MeEpisodes

Get User's Saved Episodes
EpisodeListPage me().episodes().list(EpisodeListParamsparams = EpisodeListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/me/episodes
Save Episodes for Current User
me().episodes().save(EpisodeSaveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
PUT/me/episodes
Remove User's Saved Episodes
me().episodes().remove(EpisodeRemoveParamsparams = EpisodeRemoveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
DELETE/me/episodes
Check User's Saved Episodes
List<boolean> me().episodes().check(EpisodeCheckParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
GET/me/episodes/contains

MeShows

Get User's Saved Shows
ShowListPage me().shows().list(ShowListParamsparams = ShowListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/me/shows
Save Shows for Current User
me().shows().save(ShowSaveParamsparams = ShowSaveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
PUT/me/shows
Remove User's Saved Shows
me().shows().remove(ShowRemoveParamsparams = ShowRemoveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
DELETE/me/shows
Check User's Saved Shows
List<boolean> me().shows().check(ShowCheckParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
GET/me/shows/contains

MeFollowing

Get Followed Artists
FollowingBulkRetrieveResponse me().following().bulkRetrieve(FollowingBulkRetrieveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
GET/me/following
Follow Artists or Users
me().following().follow(FollowingFollowParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
PUT/me/following
Unfollow Artists or Users
me().following().unfollow(FollowingUnfollowParamsparams = FollowingUnfollowParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
DELETE/me/following
Check If User Follows Artists or Users
List<boolean> me().following().check(FollowingCheckParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
GET/me/following/contains

MePlayer

Get Playback State
PlayerGetStateResponse me().player().getState(PlayerGetStateParamsparams = PlayerGetStateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/me/player
Transfer Playback
me().player().transfer(PlayerTransferParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
PUT/me/player
Get Available Devices
PlayerGetDevicesResponse me().player().getDevices(PlayerGetDevicesParamsparams = PlayerGetDevicesParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/me/player/devices
Get Currently Playing Track
PlayerGetCurrentlyPlayingResponse me().player().getCurrentlyPlaying(PlayerGetCurrentlyPlayingParamsparams = PlayerGetCurrentlyPlayingParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/me/player/currently-playing
Start/Resume Playback
me().player().startPlayback(PlayerStartPlaybackParamsparams = PlayerStartPlaybackParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
PUT/me/player/play
Pause Playback
me().player().pausePlayback(PlayerPausePlaybackParamsparams = PlayerPausePlaybackParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
PUT/me/player/pause
Skip To Next
me().player().skipNext(PlayerSkipNextParamsparams = PlayerSkipNextParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/me/player/next
Skip To Previous
me().player().skipPrevious(PlayerSkipPreviousParamsparams = PlayerSkipPreviousParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/me/player/previous
Seek To Position
me().player().seekToPosition(PlayerSeekToPositionParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
PUT/me/player/seek
Set Repeat Mode
me().player().setRepeatMode(PlayerSetRepeatModeParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
PUT/me/player/repeat
Set Playback Volume
me().player().setVolume(PlayerSetVolumeParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
PUT/me/player/volume
Toggle Playback Shuffle
me().player().toggleShuffle(PlayerToggleShuffleParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
PUT/me/player/shuffle
Get Recently Played Tracks
PlayerListRecentlyPlayedPage me().player().listRecentlyPlayed(PlayerListRecentlyPlayedParamsparams = PlayerListRecentlyPlayedParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/me/player/recently-played
ModelsExpand Collapse
class ContextObject:
Optional<ExternalUrlObject> externalUrls

External URLs for this context.

Optional<Boolean> published

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

Optional<String> spotify

The Spotify URL for the object.

Optional<String> href

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

Optional<Boolean> published

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

Optional<String> type

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

Optional<String> uri

The Spotify URI for the context.

class DeviceObject:
Optional<String> id

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.

Optional<Boolean> isActive

If this device is the currently active device.

Optional<Boolean> isPrivateSession

If this device is currently in a private session.

Optional<Boolean> isRestricted

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

Optional<String> name

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.

Optional<Boolean> published

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

Optional<Boolean> supportsVolume

If this device can be used to set the volume.

Optional<String> type

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

Optional<Long> volumePercent

The current volume in percent.

minimum0
maximum100

MePlayerQueue

Get the User's Queue
QueueGetResponse me().player().queue().get(QueueGetParamsparams = QueueGetParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/me/player/queue
Add Item to Playback Queue
me().player().queue().add(QueueAddParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/me/player/queue