Sign in

v1

latestOpenAPI 3.0.32026-07-139687282.9 KB
Player

Get Playback State

Get information about the user’s current playback state, including track or episode, progress, and active device.

get/me/player

Query parameters

marketstring

An ISO 3166-1 alpha-2 country code. If a country code is specified, only content that is available in that market will be returned.<br/> If a valid user access token is specified in the request header, the country associated with the user account will take priority over this parameter.<br/> Note: If neither market or user country are provided, the content is considered unavailable for the client.<br/> Users can view the country that is associated with their account in the account settings.

Example:ES
additional_typesstring

A comma-separated list of item types that your client supports besides the default track type. Valid types are: track and episode.<br/> Note: This parameter was introduced to allow existing clients to maintain their current behaviour and might be deprecated in the future.<br/> In addition to providing this parameter, make sure that your client properly handles cases of new types in the future by checking against the type field of each object.

Response

Information about playback

repeat_statestring

off, track, context

shuffle_stateboolean

If shuffle is on or off.

timestampinteger

Unix Millisecond Timestamp when playback state was last changed (play, pause, skip, scrub, new song, etc.).

progress_msinteger

Progress into the currently playing track or episode. Can be null.

is_playingboolean

If something is currently playing, return true.

currently_playing_typestring

The object type of the currently playing item. Can be one of track, episode, ad or unknown.

Example response

{
  "device": {
    "name": "Kitchen speaker",
    "type": "computer",
    "volume_percent": 59
  },
  "item": {
    "album": {
      "album_type": "compilation",
      "total_tracks": 9,
      "available_markets": [
        "CA",
        "BR",
        "IT"
      ],
      "id": "2up3OPMp9Tb4dAKM2erWXQ",
      "images": [
        {
          "url": "https://i.scdn.co/image/ab67616d00001e02ff9ca10b55ce82ae553c8228\n",
          "height": 300,
          "width": 300
        }
      ],
      "release_date": "1981-12",
      "release_date_precision": "year",
      "uri": "spotify:album:2up3OPMp9Tb4dAKM2erWXQ"
    }
  }
}