Skip to content
DocumentationAPI Reference

Player

Get Playback State
$ spotted me:player get-state
GET/me/player
Transfer Playback
$ spotted me:player transfer
PUT/me/player
Get Available Devices
$ spotted me:player get-devices
GET/me/player/devices
Get Currently Playing Track
$ spotted me:player get-currently-playing
GET/me/player/currently-playing
Start/Resume Playback
$ spotted me:player start-playback
PUT/me/player/play
Pause Playback
$ spotted me:player pause-playback
PUT/me/player/pause
Skip To Next
$ spotted me:player skip-next
POST/me/player/next
Skip To Previous
$ spotted me:player skip-previous
POST/me/player/previous
Seek To Position
$ spotted me:player seek-to-position
PUT/me/player/seek
Set Repeat Mode
$ spotted me:player set-repeat-mode
PUT/me/player/repeat
Set Playback Volume
$ spotted me:player set-volume
PUT/me/player/volume
Toggle Playback Shuffle
$ spotted me:player toggle-shuffle
PUT/me/player/shuffle
Get Recently Played Tracks
$ spotted me:player list-recently-played
GET/me/player/recently-played
ModelsExpand Collapse
context_object: object { external_urls, href, published, 2 more }
external_urls: optional object { published, spotify }

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.

device_object: object { id, is_active, is_private_session, 6 more }
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.

is_active: optional boolean

If this device is the currently active device.

is_private_session: optional boolean

If this device is currently in a private session.

is_restricted: 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

supports_volume: optional boolean

If this device can be used to set the volume.

type: optional string

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

volume_percent: optional number

The current volume in percent.

minimum0
maximum100

PlayerQueue

Get the User's Queue
$ spotted me:player:queue get
GET/me/player/queue
Add Item to Playback Queue
$ spotted me:player:queue add
POST/me/player/queue