Spotify


The Spotify media player integration allows you to control Spotify playback from Home Assistant.

Prerequisites

  • Spotify account
  • Spotify application configured for Home Assistant (see below)
Spotify integrated media controls (pause, play, next, etc.) require a Premium account. If you do not have a Premium account, the frontend will not show the controls.

Create a Spotify application

  • Login to Spotify Developer via Dashboard.
  • Visit the My Applications page.
  • Select Create An App. Enter any name and description.
  • Once your application is created, view it and copy your Client ID and Client Secret, which are used in the Home Assistant configuration file below.
  • Enter the Edit Settings dialog of your newly-created application and add a Redirect URI:
    • If you are not using SSL: http://<your_home_assistant_url_or_local_ip>:<port>/auth/external/callback
    • If you are using SSL: https://<your_home_assistant_url_or_local_ip>:<port>/auth/external/callback
    • Note Spotify does a case-sensitive match of the fields above, as such ensure the Redirect URI is all lower case.
  • Click Save after adding the URI.
Your Home Assistant instance does not need to be exposed to the internet. It works just fine with local IP addresses.

Add the following to your configuration.yaml file:

# Example configuration.yaml entry
spotify:
  client_id: YOUR_CLIENT_ID
  client_secret: YOUR_CLIENT_SECRET

Configuration Variables

client_id string Required

Client ID from your Spotify Developer application.

client_secret string Required

Client Secret from your Spotify Developer application.

Restart your Home Assistant instance before continuing with the next step.

Configuration

Adding Spotify to your Home Assistant instance can be done via the user interface, by using this My button:

Spotify can be auto-discovered by Home Assistant. If an instance was found, it will be shown as “Discovered”, which you can select to set it up right away.

Manual configuration steps

If you receive an INVALID_CLIENT: Invalid redirect URI error while trying to authenticate with your Spotify account, check the Redirect URI in the address bar after adding the new integration. Compare this value with the Redirect URI defined in the Spotify Developer Portal.

Using multiple Spotify accounts

This integration supports multiple Spotify accounts at once. You don’t need to create another Spotify application in the Spotify Developer Portal and no modification to the configuration.yaml file is needed. Multiple Spotify accounts can be linked to a single Spotify application. You will have to add those accounts into the Users and Access section of your application in the Spotify Developer Portal.

To add an additional Spotify account to Home Assistant, go to the Spotify website and log out, then repeat only the steps in the Configuration section.

Playing Spotify playlists

You can send playlists to Spotify using the "media_content_type": "playlist", which is part of the media_player.play_media service, for example:

# Example script to play playlist
script:
  play_jazz_guitar:
    sequence:
      - service: media_player.play_media
        target:
          entity_id: media_player.spotify
        data:
          media_content_id: "https://open.spotify.com/playlist/5xddIVAtLrZKtt4YGLM1SQ?si=YcvRqaKNTxOi043Qn4LYkg"
          media_content_type: playlist

The media_content_id value can be obtained from the Spotify desktop app by clicking on the more options (”…”) next to the album art picture, selecting “Share” and then “Copy Spotify URI” or “Copy Playlist Link” (also available in the Spotify phone and web app).

Unsupported Devices

  • Sonos: Although Sonos is a Spotify Connect device, it is not supported by the official Spotify API.