Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

spottydl

Package Overview
Dependencies
Maintainers
1
Versions
13
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

spottydl

NodeJS Spotify Downloader without any API Keys or Authentication

  • 0.1.2
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
119
increased by3.48%
Maintainers
1
Weekly downloads
 
Created
Source

Spottydl

A NodeJS Spotify Downloader package without any API Keys or authentication from Spotify or Youtube-Music.

However, this requires ffmpeg to be installed on your system...

Project Status

  • Automatic tagging of .mp3 files using Node-ID3 includes Year, Artist, Album, Title, and Art Cover
  • Simple and easy to use, contains only 4 usable methods 🤔 I do need some help optimizing some parts
  • Error checking, when downloading Tracks or Albums, like retrying the process when status failed...
  • Downloading playlists, as of now Spotify Tracks/Albums are currently supported

Installation

Make sure you have ffmpeg installed on your system preferably version >= 4.0

# NPM
npm i spotifydl-core
# Yarn
yarn add spotifydl-core

Usage

First we require/import the module
// If you use plain Javascript
const SpottyDL = require('spottydl')
// If typescript
import SpottyDL from 'spottydl'
Getting a Track Info
(async() => {
    await SpottyDL.getTrack("https://open.spotify.com/track/4cOdK2wGLETKBW3PvgPWqT")
        .then(results => { // Returns a <Track>
            console.log(results)
        });
})();

/* Example Output
{
  title: 'Never Gonna Give You Up',
  artist: 'Rick Astley',
  year: '1987-11-12',
  album: 'Whenever You Need Somebody',
  id: 'lYBUbBu4W08', // videoId From Youtube-Music
  albumCoverURL: 'https://i.scdn.co/image/ab67616d0000b2735755e164993798e0c9ef7d7a',
  trackNumber: 1
}
*/
Getting an Album/Single Info
(async() => {
    await SpottyDL.getAlbum("https://open.spotify.com/album/2mxFsS5yylSTHNivV53HoA")
        .then(results => { // Returns an <Album>
            console.log(results)
        });
})();

/* Example Output
{
  name: 'Cigarettes After Sex',
  artist: 'Cigarettes After Sex',
  year: '2017-06-09',
  tracks: [
    { name: 'K.', id: 'L4sbDxR22z4', trackNumber: 1 },
    ...
    ],
  albumCoverURL: 'https://i.scdn.co/image/ab67616d0000b27394d280f0006107be47bb4fe7'
}
*/
Downloading a Track
(async() => {
    await SpottyDL.getTrack("https://open.spotify.com/track/4cOdK2wGLETKBW3PvgPWqT")
        .then(async(results) => {
            let track = await SpottyDL.downloadTrack(results, "~/somePath") // Second parameter is optional...
            console.log(track)
        });
})();

/* Example Output (Successful)
[ 
  { status: 'Success', filename: '~/somePath/Never Gonna Give You Up.mp3' }
]
*/

/* Example Output (Failed)
[ 
  { 
    status: 'Failed (stream)', 
    filename: ~/somePath/Never Gonna Give You Up.mp3, 
    id: 'lYBUbBu4W08', // videoId from YT-Music
    tags: {
      title: 'Never Gonna Give You Up',
      artist: 'Rick Astley',
      year: '1987-11-12',
      ...
    }
  }
]
*/
Downloading an Album/Single
(async() => {
    await SpottyDL.getAlbum("https://open.spotify.com/album/66MRfhZmuTuyGCO1dJZTRB")
        .then(async(results) => {
            let album = await SpottyDL.downloadAlbum(results, "output/", false)
            console.log(album)
        });
})();

/* Example Output (Successful)
[
  { status: 'Success', filename: 'output/Crush.mp3' },
  { status: 'Success', filename: 'output/Sesame Syrup.mp3' }
]
*/

/* Example Output (Failed) some tracks failed proceed to use `retryDownload()` method
[
  { 
    status: 'Failed (Stream)', 
    filename: 'output/Crush.mp3',
    id: YT-Music id, 
    tags: {
      // tags for the track... 
    }
  },
  { status: 'Success', filename: 'output/Sesame Syrup.mp3' }
]
*/
Retrying a failed download (Album/Track)
(async() => {
    await SpottyDL.getAlbum("https://open.spotify.com/album/66MRfhZmuTuyGCO1dJZTRB")
        .then(async(results) => {
            let album = await SpottyDL.downloadAlbum(results, "output/", false)
            let res = await SpottyDL.retryDownload(album); 
            console.log(res) // boolean or <Results[]>
        });
})();

// Using a while loop until all tracks have no errors (Experimental)

(async() => {
    await SpottyDL.getAlbum("https://open.spotify.com/album/66MRfhZmuTuyGCO1dJZTRB")
        .then(async(results) => {
            let album = await SpottyDL.downloadAlbum(results, "output/", false)
            let res = await SpottyDL.retryDownload(album); 
            while(res != true) {
               res = await SpottyDL.retryDownload(res);
               console.log(res) // boolean or <Results[]>
            }
        });
})();

Notes

What this module simply does is that it scrapes data from Spotify, then finds the right track/song from Youtube-Music.

Hence, there's no illegal action or DRM bypass being done within this module, as all data is freely taken and used the right way

Special Thanks to:

ytdl-core

ytmusic-api

node-id3

And other notable NodeJS Spotify downloader projects :D

Keywords

FAQs

Package last updated on 23 Jan 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc