Spotify Web API
  1. category-player
Spotify Web API
  • category-albums
    • Get Multiple Albums
      GET
    • Get an Album
      GET
    • Get an Album's Tracks
      GET
  • category-artists
    • Get Multiple Artists
      GET
    • Get an Artist
      GET
    • Get an Artist's Albums
      GET
    • Get an Artist's Related Artists
      GET
    • Get an Artist's Top Tracks
      GET
  • category-tracks
    • Get Audio Analysis for a Track
      GET
    • Get Audio Features for Several Tracks
      GET
    • Get Audio Features for a Track
      GET
    • Get Several Tracks
      GET
    • Get a Track
      GET
  • category-browse
    • Get All Categories
    • Get a Category
    • Get a Category's Playlists
    • Get All Featured Playlists
    • Get All New Releases
    • Get Recommendations
    • Get Recommendation Genres
  • category-episodes
    • Get Multiple Episodes
    • Get an Episode
  • category-markets
    • Get Available Markets
  • category-users-profile
    • Get Current User's Profile
    • Get a User's Profile
  • category-library
    • Remove Albums for Current User
    • Get User's Saved Albums
    • Save Albums for Current User
    • Check User's Saved Albums
    • Remove User's Saved Episodes
    • Get User's Saved Episodes
    • Save Episodes for User
    • Check User's Saved Episodes
    • Remove User's Saved Shows
    • Get User's Saved Shows
    • Save Shows for Current User
    • Check User's Saved Shows
    • Remove User's Saved Tracks
    • Get User's Saved Tracks
    • Save Tracks for User
    • Check User's Saved Tracks
  • category-follow
    • Unfollow Artists or Users
    • Get User's Followed Artists
    • Follow Artists or Users
    • Get Following State for Artists/Users
    • Unfollow Playlist
    • Follow a Playlist
    • Check if Users Follow a Playlist
  • category-player
    • Get Information About The User's Current Playback
      GET
    • Transfer a User's Playback
      PUT
    • Get the User's Currently Playing Track
      GET
    • Get a User's Available Devices
      GET
    • Skip User’s Playback To Next Track
      POST
    • Pause a User's Playback
      PUT
    • Start/Resume a User's Playback
      PUT
    • Skip User’s Playback To Previous Track
      POST
    • Add an item to queue
      POST
    • Get Current User's Recently Played Tracks
      GET
    • Set Repeat Mode On User’s Playback
      PUT
    • Seek To Position In Currently Playing Track
      PUT
    • Toggle Shuffle For User’s Playback
      PUT
    • Set Volume For User's Playback
      PUT
  • category-playlists
    • Get a List of Current User's Playlists
    • Get a Playlist
    • Change a Playlist's Details
    • Get a Playlist Cover Image
    • Upload a Custom Playlist Cover Image
    • Remove Items from a Playlist
    • Get a Playlist's Items
    • Add Items to a Playlist
    • Reorder or Replace a Playlist's Items
    • Get a List of a User's Playlists
    • Create a Playlist
  • category-personalization
    • Get a User's Top Artists and Tracks
  • category-search
    • Search for an Item
  • category-shows
    • Get Multiple Shows
    • Get a Show
    • Get a Show's Episodes
  1. category-player

Get Information About The User's Current Playback

Developing
GET
/me/player
category-player
Get information about the user's current playback state, including track or episode, progress, and active device.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.spotify.com/v1/me/player' \
--header 'Authorization;'
Response Response Example
200 - Example 1
{
  "actions": {
    "interrupting_playback": true,
    "pausing": true,
    "resuming": true,
    "seeking": true,
    "skipping_next": true,
    "skipping_prev": true,
    "toggling_repeat_context": true,
    "toggling_repeat_track": true,
    "toggling_shuffle": true,
    "transferring_playback": true
  },
  "context": {
    "external_urls": {
      "spotify": "string"
    },
    "href": "string",
    "type": "string",
    "uri": "string"
  },
  "currently_playing_type": "string",
  "device": {
    "id": "string",
    "is_active": true,
    "is_private_session": true,
    "is_restricted": true,
    "name": "string",
    "type": "string",
    "volume_percent": 0
  },
  "is_playing": true,
  "item": {
    "album": {
      "album_group": "string",
      "album_type": "string",
      "artists": [
        {
          "external_urls": {
            "spotify": "string"
          },
          "href": "string",
          "id": "string",
          "name": "string",
          "type": "string",
          "uri": "string"
        }
      ],
      "available_markets": [
        "string"
      ],
      "external_urls": {
        "spotify": "string"
      },
      "href": "string",
      "id": "string",
      "images": [
        {
          "height": 0,
          "url": "string",
          "width": 0
        }
      ],
      "name": "string",
      "release_date": "string",
      "release_date_precision": "string",
      "restrictions": {
        "reason": "string"
      },
      "total_tracks": 0,
      "type": "string",
      "uri": "string"
    },
    "artists": [
      {
        "external_urls": {
          "spotify": "string"
        },
        "followers": {
          "href": "string",
          "total": 0
        },
        "genres": [
          "string"
        ],
        "href": "string",
        "id": "string",
        "images": [
          {
            "height": 0,
            "url": "string",
            "width": 0
          }
        ],
        "name": "string",
        "popularity": 0,
        "type": "string",
        "uri": "string"
      }
    ],
    "available_markets": [
      "string"
    ],
    "disc_number": 0,
    "duration_ms": 0,
    "explicit": true,
    "external_ids": {
      "ean": "string",
      "isrc": "string",
      "upc": "string"
    },
    "external_urls": {
      "spotify": "string"
    },
    "href": "string",
    "id": "string",
    "is_local": true,
    "is_playable": true,
    "linked_from": {
      "external_urls": {
        "spotify": "string"
      },
      "href": "string",
      "id": "string",
      "type": "string",
      "uri": "string"
    },
    "name": "string",
    "popularity": 0,
    "preview_url": "string",
    "restrictions": {
      "reason": "string"
    },
    "track_number": 0,
    "type": "string",
    "uri": "string"
  },
  "progress_ms": 0,
  "repeat_state": "string",
  "shuffle_state": "string",
  "timestamp": 0
}

Request

Query Params
market
string 
optional
An ISO 3166-1 alpha-2 country code or the string from_token. Provide this parameter if you want to apply Track
Relinking.
additional_types
string 
optional
A comma-separated list of item types that your client supports besides the default track type. Valid types are: track and episode. An unsupported type in the response is expected to be represented as null value in the item field. Note: This parameter was introduced to allow existing clients to maintain their current behaviour and might be deprecated in the future. In addition to providing this parameter, make sure that your client properly handles cases of new
Header Params
Authorization
string 
required
A valid access token from the Spotify Accounts service: see the Web API Authorization Guide for details.

Responses

🟢200A successful request will return a `200 OK` response code with a json payload that contains information about the current playback. The information returned is for the last known state, which means an inactive device could be returned if it was the last o
application/json
Body
actions
object (DisallowsObject) 
optional
interrupting_playback
boolean 
optional
Interrupting playback. Optional field.
pausing
boolean 
optional
Pausing. Optional field.
resuming
boolean 
optional
Resuming. Optional field.
seeking
boolean 
optional
Seeking playback location. Optional field.
skipping_next
boolean 
optional
Skipping to the next context. Optional field.
skipping_prev
boolean 
optional
Skipping to the previous context. Optional field.
toggling_repeat_context
boolean 
optional
Toggling repeat context flag. Optional field.
toggling_repeat_track
boolean 
optional
Toggling repeat track flag. Optional field.
toggling_shuffle
boolean 
optional
Toggling shuffle flag. Optional field.
transferring_playback
boolean 
optional
Transfering playback between devices. Optional field.
context
object (ContextObject) 
optional
external_urls
object (ExternalUrlObject) 
optional
href
string 
optional
A link to the Web API endpoint providing full details of the track.
type
string 
optional
The object type, e.g. "artist", "playlist", "album", "show".
uri
string 
optional
The Spotify URI for the context.
currently_playing_type
string 
optional
The object type of the currently playing item. Can be one of track, episode, ad or unknown.
device
object (DeviceObject) 
optional
id
string 
optional
The device ID.
is_active
boolean 
optional
If this device is the currently active device.
is_private_session
boolean 
optional
If this device is currently in a private session.
is_restricted
boolean 
optional
Whether controlling this device is restricted. At present if this is "true" then no Web API commands will be accepted by this device.
name
string 
optional
The name of the device.
type
string 
optional
Device type, such as "computer", "smartphone" or "speaker".
volume_percent
integer <int32>
optional
The current volume in percent.
is_playing
boolean 
optional
If something is currently playing, return true.
item
optional
The currently playing track or episode. Can be null.
One of
album
object 
SimplifiedAlbumObject
optional
artists
array[object (ArtistObject) {10}] 
optional
The artists who performed the track. Each artist object includes a link in href to more detailed information about the artist.
available_markets
array[string]
optional
A list of the countries in which the track can be played, identified by their ISO 3166-1 alpha-2 code.
disc_number
integer <int32>
optional
The disc number (usually 1 unless the album consists of more than one disc).
duration_ms
integer <int32>
optional
The track length in milliseconds.
explicit
boolean 
optional
Whether or not the track has explicit lyrics ( true = yes it does; false = no it does not OR unknown).
external_ids
object 
ExternalIdObject
optional
external_urls
object 
ExternalUrlObject
optional
href
string 
optional
A link to the Web API endpoint providing full details of the track.
id
string 
optional
The Spotify ID for the track.
is_local
boolean 
optional
Whether or not the track is from a local file.
is_playable
boolean 
optional
Part of the response when Track Relinking is applied. If true , the track is playable in the given market. Otherwise false.
linked_from
object 
LinkedTrackObject
optional
name
string 
optional
The name of the track.
popularity
integer <int32>
optional
The popularity of the track. The value will be between 0 and 100, with 100 being the most popular.
The popularity of a track is a value between 0 and 100, with 100 being the most popular. The popularity is calculated by algorithm and is based, in the most part, on the total number of plays the track has had and how recent those plays are.
Generally speaking, songs that are being played a lot now will have a higher popularity than songs that were played a lot in the past. Duplicate tracks (e.g. the same track from a single and an album) are rated independently. Artist and album popularity is derived mathematically from track popularity. Note that the popularity value may lag actual popularity by a few days: the value is not updated in real time.
preview_url
string 
optional
A link to a 30 second preview (MP3 format) of the track. Can be null
restrictions
object 
TrackRestrictionObject
optional
track_number
integer <int32>
optional
The number of the track. If an album has several discs, the track number is the number on the specified disc.
type
string 
optional
The object type: "track".
uri
string 
optional
The Spotify URI for the track.
progress_ms
integer <int32>
optional
Progress into the currently playing track or episode. Can be null.
repeat_state
string 
optional
off, track, context
shuffle_state
string 
optional
If shuffle is on or off.
timestamp
integer <int32>
optional
Unix Millisecond Timestamp when data was fetched.
🟢204A successful request will return a `200 OK` response code with a json payload that contains information about the current playback. The information returned is for the last known state, which means an inactive device could be returned if it was the last o
🔴500500
Modified at 2022-09-12 10:04:50
Previous
Check if Users Follow a Playlist
Next
Transfer a User's Playback
Built with