Getting Started

This guide will help you set up Spotify integration with plistsync from start to finish.

Prerequisites

Installation

First, install the Spotify optional dependencies:

pip

pip install 'plistsync[spotify]'

uv

uv add plistsync --extra spotify

Spotify Account

You’ll need an active and paid Spotify account.

Note

Since February 2026, Spotify

• no longer allows access to its API for free accounts

• and limits us to 5 users per App, even for paid accounts.

This means we can no longer provide working API credentials for plistsync users. You have to create you own credentials.

API Credentials

To authenticate with Spotify’s API, you need to obtain API credentials:

1. Visit the Spotify Developer Portal

2. Log in with your paid Spotify account

3. Create a new application

4. Generate your client_id and client_secret

Configuration

Enable Spotify in your plistsync configuration file:

# ./config/config.yaml
services:
  spotify:
    enabled: true
    client_id: your_spotify_client_id_here
    client_secret: your_spotify_client_secret_here # Optional but recommended

Authentication

Once configured, authenticate plistsync with your Spotify account:

plistsync auth spotify

This will start an interactive authentication flow:

1. You’ll be prompted to open a browser to Spotify’s authorization page

2. Log in with your Spotify credentials

3. Grant plistsync the requested permissions

4. This will save an authentication token in the config folder

Authentication Preview

Verification

Test that everything is working by getting your user data:

from plistsync.services.spotify.api import SpotifyApi
print(SpotifyApi().user.me())

This should return your user’s ID and email.