Skip to content
DocumentationAPI Reference

Player

Get Playback State
PlayerGetStateResponse Me.Player.GetState(PlayerGetStateParams?parameters, CancellationTokencancellationToken = default)
GET/me/player
Transfer Playback
Me.Player.Transfer(PlayerTransferParamsparameters, CancellationTokencancellationToken = default)
PUT/me/player
Get Available Devices
PlayerGetDevicesResponse Me.Player.GetDevices(PlayerGetDevicesParams?parameters, CancellationTokencancellationToken = default)
GET/me/player/devices
Get Currently Playing Track
PlayerGetCurrentlyPlayingResponse Me.Player.GetCurrentlyPlaying(PlayerGetCurrentlyPlayingParams?parameters, CancellationTokencancellationToken = default)
GET/me/player/currently-playing
Start/Resume Playback
Me.Player.StartPlayback(PlayerStartPlaybackParams?parameters, CancellationTokencancellationToken = default)
PUT/me/player/play
Pause Playback
Me.Player.PausePlayback(PlayerPausePlaybackParams?parameters, CancellationTokencancellationToken = default)
PUT/me/player/pause
Skip To Next
Me.Player.SkipNext(PlayerSkipNextParams?parameters, CancellationTokencancellationToken = default)
POST/me/player/next
Skip To Previous
Me.Player.SkipPrevious(PlayerSkipPreviousParams?parameters, CancellationTokencancellationToken = default)
POST/me/player/previous
Seek To Position
Me.Player.SeekToPosition(PlayerSeekToPositionParamsparameters, CancellationTokencancellationToken = default)
PUT/me/player/seek
Set Repeat Mode
Me.Player.SetRepeatMode(PlayerSetRepeatModeParamsparameters, CancellationTokencancellationToken = default)
PUT/me/player/repeat
Set Playback Volume
Me.Player.SetVolume(PlayerSetVolumeParamsparameters, CancellationTokencancellationToken = default)
PUT/me/player/volume
Toggle Playback Shuffle
Me.Player.ToggleShuffle(PlayerToggleShuffleParamsparameters, CancellationTokencancellationToken = default)
PUT/me/player/shuffle
Get Recently Played Tracks
PlayerListRecentlyPlayedPageResponse Me.Player.ListRecentlyPlayed(PlayerListRecentlyPlayedParams?parameters, CancellationTokencancellationToken = default)
GET/me/player/recently-played
ModelsExpand Collapse
class ContextObject:
ExternalUrlObject ExternalUrls

External URLs for this context.

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

string Spotify

The Spotify URL for the object.

string Href

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

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

string Type

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

string Uri

The Spotify URI for the context.

class DeviceObject:
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.

Boolean IsActive

If this device is the currently active device.

Boolean IsPrivateSession

If this device is currently in a private session.

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.

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.

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

Boolean SupportsVolume

If this device can be used to set the volume.

string Type

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

Long? VolumePercent

The current volume in percent.

minimum0
maximum100

PlayerQueue

Get the User's Queue
QueueGetResponse Me.Player.Queue.Get(QueueGetParams?parameters, CancellationTokencancellationToken = default)
GET/me/player/queue
Add Item to Playback Queue
Me.Player.Queue.Add(QueueAddParamsparameters, CancellationTokencancellationToken = default)
POST/me/player/queue