Skip to content

Me

Get Current User's Profile

me.retrieve() -> MeRetrieveResponse

GET/me

MeAudiobooks

Get User's Saved Audiobooks

me.audiobooks.list() -> SyncCursorURLPage[AudiobookListResponse]

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() -> AudiobookCheckResponse

GET/me/audiobooks/contains

MePlaylists

Get Current User's Playlists

me.playlists.list() -> SyncCursorURLPage[SimplifiedPlaylistObject]

GET/me/playlists

MeTop

Get User's Top Tracks

me.top.list_top_tracks() -> SyncCursorURLPage[TrackObject]

GET/me/top/tracks

Get User's Top Artists

me.top.list_top_artists() -> SyncCursorURLPage[ArtistObject]

GET/me/top/artists

MeAlbums

Get User's Saved Albums

me.albums.list() -> SyncCursorURLPage[AlbumListResponse]

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() -> AlbumCheckResponse

GET/me/albums/contains

MeTracks

Get User's Saved Tracks

me.tracks.list() -> SyncCursorURLPage[TrackListResponse]

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() -> TrackCheckResponse

GET/me/tracks/contains

MeEpisodes

Get User's Saved Episodes

me.episodes.list() -> SyncCursorURLPage[EpisodeListResponse]

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() -> EpisodeCheckResponse

GET/me/episodes/contains

MeShows

Get User's Saved Shows

me.shows.list() -> SyncCursorURLPage[ShowListResponse]

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() -> ShowCheckResponse

GET/me/shows/contains

MeFollowing

Get Followed Artists

me.following.bulk_retrieve() -> 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() -> FollowingCheckResponse

GET/me/following/contains

MePlayer

Get Playback State

me.player.get_state() -> PlayerGetStateResponse

GET/me/player

Transfer Playback

me.player.transfer()

PUT/me/player

Get Available Devices

me.player.get_devices() -> PlayerGetDevicesResponse

GET/me/player/devices

Get Currently Playing Track

me.player.get_currently_playing() -> PlayerGetCurrentlyPlayingResponse

GET/me/player/currently-playing

Start/Resume Playback

me.player.start_playback()

PUT/me/player/play

Pause Playback

me.player.pause_playback()

PUT/me/player/pause

Skip To Next

me.player.skip_next()

POST/me/player/next

Skip To Previous

me.player.skip_previous()

POST/me/player/previous

Seek To Position

me.player.seek_to_position()

PUT/me/player/seek

Set Repeat Mode

me.player.set_repeat_mode()

PUT/me/player/repeat

Set Playback Volume

me.player.set_volume()

PUT/me/player/volume

Toggle Playback Shuffle

me.player.toggle_shuffle()

PUT/me/player/shuffle

Get Recently Played Tracks

me.player.list_recently_played() -> SyncCursorURLPage[PlayerListRecentlyPlayedResponse]

GET/me/player/recently-played

ModelsExpand Collapse

class ContextObject: …

external_urls: Optional[ExternalURLObject]

External URLs for this context.

published: Optional[bool]

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[str]

The Spotify URL for the object.

href: Optional[str]

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

published: Optional[bool]

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[str]

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

uri: Optional[str]

The Spotify URI for the context.

class DeviceObject: …

id: Optional[str]

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.

is_active: Optional[bool]

If this device is the currently active device.

is_private_session: Optional[bool]

If this device is currently in a private session.

is_restricted: Optional[bool]

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[str]

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[bool]

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

supports_volume: Optional[bool]

If this device can be used to set the volume.

type: Optional[str]

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

volume_percent: Optional[int]

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