Get Currently Playing Track

me.player.get_currently_playing() -> PlayerGetCurrentlyPlayingResponse

GET/me/player/currently-playing

Get the object currently being played on the user's Spotify account.

ParametersExpand Collapse

additional_types: Optional[str]

A comma-separated list of item types that your client supports besides the default track type. Valid types are: track and episode.
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 types in the future by checking against the type field of each object.

market: Optional[str]

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.
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.
Note: If neither market or user country are provided, the content is considered unavailable for the client.
Users can view the country that is associated with their account in the account settings.

ReturnsExpand Collapse

class PlayerGetCurrentlyPlayingResponse: …

actions: Optional[Actions]

Allows to update the user interface based on which playback actions are available within the current context.

interrupting_playback: Optional[bool]

Interrupting playback. Optional field.

pausing: Optional[bool]

Pausing. Optional field.

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

resuming: Optional[bool]

Resuming. Optional field.

seeking: Optional[bool]

Seeking playback location. Optional field.

skipping_next: Optional[bool]

Skipping to the next context. Optional field.

skipping_prev: Optional[bool]

Skipping to the previous context. Optional field.

toggling_repeat_context: Optional[bool]

Toggling repeat context flag. Optional field.

toggling_repeat_track: Optional[bool]

Toggling repeat track flag. Optional field.

toggling_shuffle: Optional[bool]

Toggling shuffle flag. Optional field.

transferring_playback: Optional[bool]

Transfering playback between devices. Optional field.

context: Optional[ContextObject]

A Context Object. Can be null.

external_urls: Optional[ExternalURLObject]

External URLs for this context.

published: Optional[bool]

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]

type: Optional[str]

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

uri: Optional[str]

The Spotify URI for the context.

currently_playing_type: Optional[str]

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

is_playing: Optional[bool]

If something is currently playing, return true.

item: Optional[Item]

The currently playing track or episode. Can be null.

Accepts one of the following:

class TrackObject: …

id: Optional[str]

The Spotify ID for the track.

album: Optional[Album]

The album on which the track appears. The album object includes a link in href to full information about the album.

id: str

The Spotify ID for the album.

album_type: Literal["album", "single", "compilation"]

The type of the album.

Accepts one of the following:

"album"

"single"

"compilation"

artists: List[SimplifiedArtistObject]

The artists of the album. Each artist object includes a link in href to more detailed information about the artist.

id: Optional[str]

The Spotify ID for the artist.

external_urls: Optional[ExternalURLObject]

Known external URLs for this artist.

published: Optional[bool]

spotify: Optional[str]

The Spotify URL for the object.

href: Optional[str]

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

The name of the artist.

published: Optional[bool]

type: Optional[Literal["artist"]]

The object type.

uri: Optional[str]

The Spotify URI for the artist.

available_markets: List[str]

The markets in which the album is available: ISO 3166-1 alpha-2 country codes. NOTE: an album is considered available in a market when at least 1 of its tracks is available in that market.

external_urls: ExternalURLObject

Known external URLs for this album.

published: Optional[bool]

spotify: Optional[str]

The Spotify URL for the object.

href: str

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

images: List[ImageObject]

The cover art for the album in various sizes, widest first.

height: Optional[int]

The image height in pixels.

url: str

The source URL of the image.

width: Optional[int]

The image width in pixels.

published: Optional[bool]

The name of the album. In case of an album takedown, the value may be an empty string.

release_date: str

The date the album was first released.

release_date_precision: Literal["year", "month", "day"]

The precision with which release_date value is known.

Accepts one of the following:

"year"

"month"

"day"

total_tracks: int

The number of tracks in the album.

type: Literal["album"]

The object type.

uri: str

The Spotify URI for the album.

published: Optional[bool]

restrictions: Optional[AlbumRestrictionObject]

Included in the response when a content restriction is applied.

published: Optional[bool]

reason: Optional[Literal["market", "product", "explicit"]]

The reason for the restriction. Albums may be restricted if the content is not available in a given market, to the user's subscription type, or when the user's account is set to not play explicit content. Additional reasons may be added in the future.

Accepts one of the following:

"market"

"product"

"explicit"

artists: Optional[List[SimplifiedArtistObject]]

The artists who performed the track. Each artist object includes a link in href to more detailed information about the artist.

id: Optional[str]

The Spotify ID for the artist.

external_urls: Optional[ExternalURLObject]

Known external URLs for this artist.

published: Optional[bool]

spotify: Optional[str]

The Spotify URL for the object.

href: Optional[str]

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

The name of the artist.

published: Optional[bool]

type: Optional[Literal["artist"]]

The object type.

uri: Optional[str]

The Spotify URI for the artist.

available_markets: Optional[List[str]]

A list of the countries in which the track can be played, identified by their ISO 3166-1 alpha-2 code.

disc_number: Optional[int]

The disc number (usually 1 unless the album consists of more than one disc).

duration_ms: Optional[int]

The track length in milliseconds.

explicit: Optional[bool]

Whether or not the track has explicit lyrics ( true = yes it does; false = no it does not OR unknown).

external_ids: Optional[ExternalIDObject]

Known external IDs for the track.

ean: Optional[str]

International Article Number

isrc: Optional[str]

International Standard Recording Code

published: Optional[bool]

upc: Optional[str]

Universal Product Code

external_urls: Optional[ExternalURLObject]

Known external URLs for this track.

published: Optional[bool]

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.

is_local: Optional[bool]

Whether or not the track is from a local file.

is_playable: Optional[bool]

Part of the response when Track Relinking is applied. If true, the track is playable in the given market. Otherwise false.

linked_from: Optional[LinkedTrackObject]

Part of the response when Track Relinking is applied, and the requested track has been replaced with different track. The track in the linked_from object contains information about the originally requested track.

id: Optional[str]

The Spotify ID for the track.

external_urls: Optional[ExternalURLObject]

Known external URLs for this track.

published: Optional[bool]

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]

type: Optional[str]

The object type: "track".

uri: Optional[str]

The Spotify URI for the track.

The name of the track.

popularity: Optional[int]

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: the popularity value may lag actual popularity by a few days: the value is not updated in real time.

Deprecatedpreview_url: Optional[str]

A link to a 30 second preview (MP3 format) of the track. Can be null

published: Optional[bool]

restrictions: Optional[TrackRestrictionObject]

Included in the response when a content restriction is applied.

published: Optional[bool]

reason: Optional[str]

The reason for the restriction. Supported values:

market - The content item is not available in the given market.
product - The content item is not available for the user's subscription type.
explicit - The content item is explicit and the user's account is set to not play explicit content.

Additional reasons may be added in the future. Note: If you use this field, make sure that your application safely handles unknown values.

track_number: Optional[int]

The number of the track. If an album has several discs, the track number is the number on the specified disc.

type: Optional[Literal["track"]]

The object type: "track".

uri: Optional[str]

The Spotify URI for the track.

class EpisodeObject: …

id: str

The Spotify ID for the episode.

Deprecatedaudio_preview_url: Optional[str]

A URL to a 30 second preview (MP3 format) of the episode. null if not available.

description: str

A description of the episode. HTML tags are stripped away from this field, use html_description field in case HTML tags are needed.

duration_ms: int

The episode length in milliseconds.

explicit: bool

Whether or not the episode has explicit content (true = yes it does; false = no it does not OR unknown).

external_urls: ExternalURLObject

External URLs for this episode.

published: Optional[bool]

spotify: Optional[str]

The Spotify URL for the object.

href: str

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

html_description: str

A description of the episode. This field may contain HTML tags.

images: List[ImageObject]

The cover art for the episode in various sizes, widest first.

height: Optional[int]

The image height in pixels.

url: str

The source URL of the image.

width: Optional[int]

The image width in pixels.

published: Optional[bool]

is_externally_hosted: bool

True if the episode is hosted outside of Spotify's CDN.

is_playable: bool

True if the episode is playable in the given market. Otherwise false.

languages: List[str]

A list of the languages used in the episode, identified by their ISO 639-1 code.

The name of the episode.

release_date: str

The date the episode was first released, for example "1981-12-15". Depending on the precision, it might be shown as "1981" or "1981-12".

release_date_precision: Literal["year", "month", "day"]

The precision with which release_date value is known.

Accepts one of the following:

"year"

"month"

"day"

show: ShowBase

The show on which the episode belongs.

id: str

The Spotify ID for the show.

available_markets: List[str]

A list of the countries in which the show can be played, identified by their ISO 3166-1 alpha-2 code.

copyrights: List[CopyrightObject]

The copyright statements of the show.

published: Optional[bool]

text: Optional[str]

The copyright text for this content.

type: Optional[str]

The type of copyright: C = the copyright, P = the sound recording (performance) copyright.

description: str

A description of the show. HTML tags are stripped away from this field, use html_description field in case HTML tags are needed.

explicit: bool

Whether or not the show has explicit content (true = yes it does; false = no it does not OR unknown).

external_urls: ExternalURLObject

External URLs for this show.

published: Optional[bool]

spotify: Optional[str]

The Spotify URL for the object.

href: str

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

html_description: str

A description of the show. This field may contain HTML tags.

images: List[ImageObject]

The cover art for the show in various sizes, widest first.

height: Optional[int]

The image height in pixels.

url: str

The source URL of the image.

width: Optional[int]

The image width in pixels.

published: Optional[bool]

is_externally_hosted: bool

True if all of the shows episodes are hosted outside of Spotify's CDN. This field might be null in some cases.

languages: List[str]

A list of the languages used in the show, identified by their ISO 639 code.

media_type: str

The media type of the show.

The name of the episode.

publisher: str

The publisher of the show.

total_episodes: int

The total number of episodes in the show.

type: Literal["show"]

The object type.

uri: str

The Spotify URI for the show.

published: Optional[bool]

type: Literal["episode"]

The object type.

uri: str

The Spotify URI for the episode.

Deprecatedlanguage: Optional[str]

The language used in the episode, identified by a ISO 639 code. This field is deprecated and might be removed in the future. Please use the languages field instead.

published: Optional[bool]

restrictions: Optional[EpisodeRestrictionObject]

Included in the response when a content restriction is applied.

published: Optional[bool]

reason: Optional[str]

The reason for the restriction. Supported values:

market - The content item is not available in the given market.
product - The content item is not available for the user's subscription type.
explicit - The content item is explicit and the user's account is set to not play explicit content.

Additional reasons may be added in the future. Note: If you use this field, make sure that your application safely handles unknown values.

resume_point: Optional[ResumePointObject]

The user's most recent position in the episode. Set if the supplied access token is a user token and has the scope 'user-read-playback-position'.

fully_played: Optional[bool]

Whether or not the episode has been fully played by the user.

published: Optional[bool]

resume_position_ms: Optional[int]

The user's most recent position in the episode in milliseconds.

progress_ms: Optional[int]

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

published: Optional[bool]

timestamp: Optional[int]

Unix Millisecond Timestamp when data was fetched

formatint64

Get Currently Playing Track

import os
from spotted import Spotted

client = Spotted(
    access_token=os.environ.get("SPOTIFY_ACCESS_TOKEN"),  # This is the default and can be omitted
)
response = client.me.player.get_currently_playing()
print(response.actions)

{
  "actions": {
    "interrupting_playback": true,
    "pausing": true,
    "published": 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": {
      "published": true,
      "spotify": "spotify"
    },
    "href": "href",
    "published": true,
    "type": "type",
    "uri": "uri"
  },
  "currently_playing_type": "currently_playing_type",
  "is_playing": true,
  "item": {
    "id": "id",
    "album": {
      "id": "2up3OPMp9Tb4dAKM2erWXQ",
      "album_type": "compilation",
      "artists": [
        {
          "id": "id",
          "external_urls": {
            "published": true,
            "spotify": "spotify"
          },
          "href": "href",
          "name": "name",
          "published": true,
          "type": "artist",
          "uri": "uri"
        }
      ],
      "available_markets": [
        "CA",
        "BR",
        "IT"
      ],
      "external_urls": {
        "published": true,
        "spotify": "spotify"
      },
      "href": "href",
      "images": [
        {
          "height": 300,
          "url": "https://i.scdn.co/image/ab67616d00001e02ff9ca10b55ce82ae553c8228\n",
          "width": 300,
          "published": true
        }
      ],
      "name": "name",
      "release_date": "1981-12",
      "release_date_precision": "year",
      "total_tracks": 9,
      "type": "album",
      "uri": "spotify:album:2up3OPMp9Tb4dAKM2erWXQ",
      "published": true,
      "restrictions": {
        "published": true,
        "reason": "market"
      }
    },
    "artists": [
      {
        "id": "id",
        "external_urls": {
          "published": true,
          "spotify": "spotify"
        },
        "href": "href",
        "name": "name",
        "published": true,
        "type": "artist",
        "uri": "uri"
      }
    ],
    "available_markets": [
      "string"
    ],
    "disc_number": 0,
    "duration_ms": 0,
    "explicit": true,
    "external_ids": {
      "ean": "ean",
      "isrc": "isrc",
      "published": true,
      "upc": "upc"
    },
    "external_urls": {
      "published": true,
      "spotify": "spotify"
    },
    "href": "href",
    "is_local": true,
    "is_playable": true,
    "linked_from": {
      "id": "id",
      "external_urls": {
        "published": true,
        "spotify": "spotify"
      },
      "href": "href",
      "published": true,
      "type": "type",
      "uri": "uri"
    },
    "name": "name",
    "popularity": 0,
    "preview_url": "preview_url",
    "published": true,
    "restrictions": {
      "published": true,
      "reason": "reason"
    },
    "track_number": 0,
    "type": "track",
    "uri": "uri"
  },
  "progress_ms": 0,
  "published": true,
  "timestamp": 0
}

Returns Examples

{
  "actions": {
    "interrupting_playback": true,
    "pausing": true,
    "published": 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": {
      "published": true,
      "spotify": "spotify"
    },
    "href": "href",
    "published": true,
    "type": "type",
    "uri": "uri"
  },
  "currently_playing_type": "currently_playing_type",
  "is_playing": true,
  "item": {
    "id": "id",
    "album": {
      "id": "2up3OPMp9Tb4dAKM2erWXQ",
      "album_type": "compilation",
      "artists": [
        {
          "id": "id",
          "external_urls": {
            "published": true,
            "spotify": "spotify"
          },
          "href": "href",
          "name": "name",
          "published": true,
          "type": "artist",
          "uri": "uri"
        }
      ],
      "available_markets": [
        "CA",
        "BR",
        "IT"
      ],
      "external_urls": {
        "published": true,
        "spotify": "spotify"
      },
      "href": "href",
      "images": [
        {
          "height": 300,
          "url": "https://i.scdn.co/image/ab67616d00001e02ff9ca10b55ce82ae553c8228\n",
          "width": 300,
          "published": true
        }
      ],
      "name": "name",
      "release_date": "1981-12",
      "release_date_precision": "year",
      "total_tracks": 9,
      "type": "album",
      "uri": "spotify:album:2up3OPMp9Tb4dAKM2erWXQ",
      "published": true,
      "restrictions": {
        "published": true,
        "reason": "market"
      }
    },
    "artists": [
      {
        "id": "id",
        "external_urls": {
          "published": true,
          "spotify": "spotify"
        },
        "href": "href",
        "name": "name",
        "published": true,
        "type": "artist",
        "uri": "uri"
      }
    ],
    "available_markets": [
      "string"
    ],
    "disc_number": 0,
    "duration_ms": 0,
    "explicit": true,
    "external_ids": {
      "ean": "ean",
      "isrc": "isrc",
      "published": true,
      "upc": "upc"
    },
    "external_urls": {
      "published": true,
      "spotify": "spotify"
    },
    "href": "href",
    "is_local": true,
    "is_playable": true,
    "linked_from": {
      "id": "id",
      "external_urls": {
        "published": true,
        "spotify": "spotify"
      },
      "href": "href",
      "published": true,
      "type": "type",
      "uri": "uri"
    },
    "name": "name",
    "popularity": 0,
    "preview_url": "preview_url",
    "published": true,
    "restrictions": {
      "published": true,
      "reason": "reason"
    },
    "track_number": 0,
    "type": "track",
    "uri": "uri"
  },
  "progress_ms": 0,
  "published": true,
  "timestamp": 0
}