Get Available Devices

me.player.get_devices() -> PlayerGetDevicesResponse

GET/me/player/devices

Get information about a user’s available Spotify Connect devices. Some device models are not supported and will not be listed in the API response.

ReturnsExpand Collapse

class PlayerGetDevicesResponse: …

devices: List[DeviceObject]

id: Optional[str]

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[bool]

If this device is the currently active device.

is_private_session: Optional[bool]

If this device is currently in a private session.

is_restricted: Optional[bool]

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[str]

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[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

supports_volume: Optional[bool]

If this device can be used to set the volume.

type: Optional[str]

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

volume_percent: Optional[int]

The current volume in percent.

minimum0

maximum100

Get Available Devices

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_devices()
print(response.devices)

{
  "devices": [
    {
      "id": "id",
      "is_active": true,
      "is_private_session": true,
      "is_restricted": true,
      "name": "Kitchen speaker",
      "published": true,
      "supports_volume": true,
      "type": "computer",
      "volume_percent": 59
    }
  ]
}

Returns Examples

{
  "devices": [
    {
      "id": "id",
      "is_active": true,
      "is_private_session": true,
      "is_restricted": true,
      "name": "Kitchen speaker",
      "published": true,
      "supports_volume": true,
      "type": "computer",
      "volume_percent": 59
    }
  ]
}