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.) requires a Premium account. If you do not have a Premium account, the integration's frontend will not show the controls.

Create a Spotify application

  • Login to Spotify Developer.
  • 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.
  • On the Spotify page, 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
  • 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.

Configuration

To add Spotify to Home Assistant, 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 application.

client_secret string Required

Client Secret from your Spotify application.

Activating the Spotify integration

  • Go to the Configurations page in the Home Assistant frontend.
  • Click on Integrations.
  • Click the orange + on the bottom-right.
  • Click on “Spotify”.
  • Once the new Spotify tab opens, enter your Spotify credentials and allow Home Assistant to access your Spotify account.

If you receive an INVALID_CLIENT: Invalid redirect URI error while trying to authenticate with your Spotify account, make sure to 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

The integration support 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.

To add an additional Spotify account to Home Assistant, repeat only the steps in the Activating the Spotify integration section. However, make sure you go to the Spotify website and log out before you do so.

URI Links for Playlists

You can send playlists to Spotify using the "media_content_type": "playlist", which is part of the media_player.play_media service. The media_content_id 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.