Skip to main content

Download your Spotify playlists and songs along with album art and metadata

Project description

spotDL v4

spotDL finds songs from Spotify playlists on YouTube and downloads them - along with album art, lyrics and metadata.

MIT License PyPI version PyPi downloads GitHub Repo stars Contributors Discord

spotDL: The fastest, easiest and most accurate command-line music downloader.


Read the documentation on ReadTheDocs!


Installation

Refer to our Installation Guide for more details.

Python (Recommended Method)

  • spotDL can be installed by running pip install spotdl.

  • To update spotDL run pip install --upgrade spotdl

    On some systems you might have to change pip to pip3.

Other options
  • Prebuilt executable
  • On Termux
    • curl -L https://raw.githubusercontent.com/spotDL/spotify-downloader/master/scripts/termux.sh | sh
  • Arch
  • Docker
    • Build image:

      docker build -t spotdl .
      
    • Launch container with spotDL parameters (see section below). You need to create mapped volume to access song files

      docker run --rm -v $(pwd):/music spotdl download [trackUrl]
      
    • For Docker Compose and permission-managed Docker downloads, see the Docker section in /docs/index.md.

    • Build from source

      git clone https://github.com/spotDL/spotify-downloader && cd spotify-downloader
      pip install uv
      uv sync
      uv run scripts/build.py
      

      An executable is created in spotify-downloader/dist/.

Installing FFmpeg

FFmpeg is required for spotDL. If using FFmpeg only for spotDL, you can simply install FFmpeg to your spotDL installation directory: spotdl --download-ffmpeg

We recommend the above option, but if you want to install FFmpeg system-wide, follow these instructions

  • Windows Tutorial
  • OSX - brew install ffmpeg
  • Linux - sudo apt install ffmpeg or use your distro's package manager

Installing Deno

We strongly recommend installing Deno. spotDL uses yt-dlp for YouTube downloads, and some videos require Deno to download successfully. Without Deno, spotDL may fail to download some songs, including videos marked as "made for kids".

If using Deno only for spotDL, install Deno to your spotDL directory: spotdl --download-deno

If you want to install Deno system-wide instead, follow the official Deno installation guide.

Usage

Using SpotDL without options:

spotdl [urls]

You can run spotDL as a package if running it as a script doesn't work:

python -m spotdl [urls]

General usage:

spotdl [operation] [options] QUERY

There are different operations spotDL can perform. The default is download, which simply downloads the songs from YouTube and embeds metadata.

The query for spotDL is usually a list of Spotify URLs, but for some operations like sync, only a single link or file is required. For a list of all options use spotdl -h

Supported operations
  • save: Saves only the metadata from Spotify without downloading anything.

    • Usage: spotdl save [query] --save-file {filename}.spotdl
  • web: Starts a web interface instead of using the command line. However, it has limited features and only supports downloading individual songs.

  • url: Get user-friendly URL for each song from the query.

    • Usage: spotdl url [query]
  • sync: Updates directories. Compares the directory with the current state of the playlist. Newly added songs will be downloaded and removed songs will be deleted. No other songs will be downloaded and no other files will be deleted.

    • Usage: spotdl sync [query] --save-file {filename}.spotdl

      This creates a new sync file. To update the directory in the future, use:

      spotdl sync {filename}.spotdl

  • meta: Updates metadata for the provided song files.

Music Sourcing and Audio Quality

spotDL uses YouTube as a source for music downloads. This method is used to avoid any issues related to downloading music from Spotify.

Note Users are responsible for their actions and potential legal consequences. We do not support unauthorized downloading of copyrighted material and take no responsibility for user actions.

Audio Quality

spotDL downloads music from YouTube and is designed to always download the highest possible bitrate; which is 128 kbps for regular users and 256 kbps for YouTube Music premium users.

Check the Audio Formats page for more info.

Contributing

Interested in contributing? Check out our CONTRIBUTING.md to find resources around contributing along with a guide on how to set up a development environment.

Join our amazing community as a code contributor

License

This project is Licensed under the MIT License.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

spotdl-4.5.1.tar.gz (3.7 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

spotdl-4.5.1-py3-none-any.whl (379.5 kB view details)

Uploaded Python 3

File details

Details for the file spotdl-4.5.1.tar.gz.

File metadata

  • Download URL: spotdl-4.5.1.tar.gz
  • Upload date:
  • Size: 3.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for spotdl-4.5.1.tar.gz
Algorithm Hash digest
SHA256 249f08b94b0c0b9ff3165fd486c71b94aff3fb850074484ebc5325fe70cb3f0c
MD5 2ca27cf9e6bdac52d02a33c88c5a64d1
BLAKE2b-256 5f87e7f7cab4a213239dea01bba4ee99310f0cd7d22ff192d4e8f2aa294000d5

See more details on using hashes here.

Provenance

The following attestation bundles were made for spotdl-4.5.1.tar.gz:

Publisher: python-publish.yml on spotDL/spotify-downloader

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file spotdl-4.5.1-py3-none-any.whl.

File metadata

  • Download URL: spotdl-4.5.1-py3-none-any.whl
  • Upload date:
  • Size: 379.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for spotdl-4.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 41959402399a27acac55b8f0e79129e6a06fbcbacfef77a76ac5b39c9737d234
MD5 69ffd10e6fcff98f9e363fa14aca17d0
BLAKE2b-256 e24590e13f5f581e17290396e409bc5b44d40cbde5d553618c475afd37c90af3

See more details on using hashes here.

Provenance

The following attestation bundles were made for spotdl-4.5.1-py3-none-any.whl:

Publisher: python-publish.yml on spotDL/spotify-downloader

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page