A client-side JS wrapper for the Spotify Web API. 

A client-side JS wrapper for the Spotify Web API

jmperez

spotify-web-api-js

Error

Ignore

Warn

License

Maintenance

Miscellaneous

Quality

Supply chain risk

Vulnerability

Admins only

Organization members

Dashboard

<upgradeLink>Upgrade</upgradeLink> to access this feature

About

Blog

Socket CLI

Customers

Socket Dependency Search

Docs

Socket for GitHub

Love

Impersonation Mode Active

Update your browser to the latest version for the best experience.

Your web browser is outdated

Use another browser for the best experience.

Your web browser is unsupported

{{count, number}} commits last two months

{{count, number}} critical severity alert

{{count, number}} critical severity alerts

{{count, number}} dependency vulnerability

{{count, number}} dependency vulnerabilities

{{count, number}} development dependencies

{{count, number}} transitive dependencies

{{count, number}} version published last month

{{count, number}} versions published last month

{{count, number}} version published in last two months

{{count, number}} versions published in last two months

{{count, number}} version published last week

{{count, number}} versions published last week

{{count, number}} version published last year

{{count, number}} versions published last year

Socket undergoes annual SOC2 Type II audits. Socket customers can request a copy of the full SOC2 Type II report.

Allows organization owners and admins to access detailed records of actions taken by members of their organization, complete with timestamps.

Prevent compromised packages from infiltrating your supply chain by monitoring for changes in real-time.

Join our Discord community to get help from Socket engineers and other Socket users.

Compare millions of open source packages on socket.dev

Detect malicious code and risky behavior (e.g. network) in your dependencies using "deep package inspection"

All data is encrypted in transit and at rest using industry standard encryption algorithms.

Get a dedicated Socket account manager and access to Socket’s Customer Success team.

Get dedicated support from Socket engineers via email and Slack.

"Shift left" with the Socket Chrome extension and give intervene early, before developers choose risky or low quality dependencies.

Catch developers using risky dependencies and give them a "speed bump" to encourage good behavior

Install the Socket GitHub app to receive real-time dependency scanning and reports with every pull request.

Integrate Socket into your GitHub SCM to prevent risky dependencies from being installed.

Socket scans for vulnerabilities in your dependencies, including CVEs, security advisories, and more.

Socket supports dependencies in many languages, with most popular ecosystems coming in 2024. We've got you covered no matter what languages you use.

Enforce license policies across your organization

Receive a Microsoft Teams message to the channel of your choice anytime Socket runs a new analysis, has a new finding, or a policy has changed.

Get help migrating from Socket's free plan to Socket's paid plans.

Run Socket on-premises or in your own cloud environment.

Query for any dependency (at any version) across your entire organization

Integrate Socket into your CI/CD pipeline to prevent risky dependencies from being deployed to production.

Analyze an entire project to find supply chain risks

Tag projects to organize and filter your projects

Restrict access based on the roles of individual users within an organization.

Receive a Slack message to the channel of your choice anytime Socket runs a new analysis, has a new finding, or a policy has changed.

Socket is SOC2 Type II compliant and undergoes annual audits.

The Socket CLI allows teams to prevent risky dependencies from being installed, and to get dependency insights from the command line.

Socket supports SAML SSO for single sign-on and identity management.

Integrate Socket into your VS Code IDE to prevent risky dependencies from being installed.

Get a POST request anytime Socket runs a new analysis, has a new finding, or a policy has changed.

Socket will analyzed your SBOMs up to a maximum number of dependencies.

API that allows you to analyze a project, lookup package scores and alerts, and more.

Create API tokens to authenticate with the Socket API and CLI.

The number of developers in your team. A developer is someone who made a commit to your organization's repositories scanned by Socket in the past month.

Use Socket to protect your private repositories.

Socket is always free for open source projects.

Socket retains all reporting data for 3 months, 1 year, or a custom term of your choice.

Access the threat feed that powers Socket.

Unlimited scale, self-hosting, and priority support for large teams.

For open-source projects, individuals, and small teams.

For growing teams with enhanced scale, security, and support.

There is a package with a similar name that is downloaded much more often.

There are packages with similar names that are downloaded much more often.

This may not be the package you want!

Instance

Alert Locations

Package

The {{ecosystem}} package {{- packageName}} receives a total of <strong>{{numWeeklyDownloadCount, number}}</strong> weekly downloads. As such, {{- packageName}} popularity was classified as <strong>{{popularity}}</strong>.

Is {{- packageName}} popular?

Is {{- packageName}} safe to use?

Is {{- packageName}} well maintained?

What is {{- packageName}}?

{{packageDescription}}Version: {{versionString}} was published by {{publisherName}}. Start using Socket to analyze {{- packageName}} and its {{dependencyCount, number}} dependencies to secure your app from supply chain attacks.

Sorry, it seems this package was removed from the registry

Package was removed

This package version has been unpublished, mostly likely due to security reasons

Package version was removed

Provide a detailed description of the malware...

Socket fights vulnerabilities and provides visibility, defense-in-depth, and proactive supply chain protection for JavaScript, Python, and Go dependencies.

Socket - Secure your dependencies. Ship with confidence.

Compare versions

{{- packageName}} - npm Package Compare versions

  "description": "A client-side JS wrapper for the Spotify Web API",

  "homepage": "https://github.com/JMPerez/spotify-web-api-js",

  "typings": "src/typings/spotify-web-api.d.ts",

    "url": "git://github.com/JMPerez/spotify-web-api-js"

    "test": "npm run lint && jest --coverage",

    "travis": "npm test && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js"

    "*.{js,css,md,json}": "prettier --single-quote --trailing-comma none --write '{**/*.ts,**/*.js,*.md,__test__/**/*.json}'"

# Spotify Web API JS [![Build Status](https://travis-ci.org/JMPerez/spotify-web-api-js.svg?branch=master)](https://travis-ci.org/JMPerez/spotify-web-api-js) [![Coverage Status](https://coveralls.io/repos/JMPerez/spotify-web-api-js/badge.svg)](https://coveralls.io/r/JMPerez/spotify-web-api-js) [![Greenkeeper badge](https://badges.greenkeeper.io/JMPerez/spotify-web-api-js.svg)](https://greenkeeper.io/)

This is a lightweight wrapper for the [Spotify Web API](https://developer.spotify.com/web-api/) ([2.4kB gzipped + compressed](https://cost-of-modules.herokuapp.com/result?p=spotify-web-api-js)). It includes helper functions for **all Spotify's endpoints**, such as fetching metadata (search and look-up of albums, artists, tracks, playlists, new releases, podcasts) and user's information (follow users, artists and playlists, and saved tracks management).

It doesn't have any dependencies and supports callbacks and promises. It is intended to be run on a browser, but if you want to use Node.JS to make the requests, please check [spotify-web-api-node](https://github.com/thelinmichael/spotify-web-api-node).

A list of selected wrappers for different languages and environments is available on the Developer site's [Libraries page](https://developer.spotify.com/web-api/code-examples/).

The wrapper includes helper functions to do the following:

- Audio features and audio analysis for tracks

- User's emails, product type, display name, birthdate, image

- Albums, artists, tracks, playlists, shows, and episodes

- Add, remove, and get tracks on a user's library

- Check if a track is in the signed in user's library

- Add, remove, and get shows (podcasts) on a user's library

- Get a user’s top artists and tracks based on calculated affinity

- Get current user’s recently played tracks

- Check if the logged in user follows a user or artist

- Check if users are following a Playlist

- Get information about the user's current playback

- Seek to position in currently playing track

Install via node (since the requests are made using XMLHttpRequest, you will need a tool like Browserify to run this on a browser):

var Spotify = require('spotify-web-api-js');

or by making a copy of the `src/spotify-web-api.js` file

We recommend you have a look at the [documentation](https://doxdox.org/jmperez/spotify-web-api-js) to get an overview of the supported

The wrapper supports callback functions, as well as [Promises](http://www.html5rocks.com/en/tutorials/es6/promises/) (you can also use [a polyfill](https://github.com/jakearchibald/es6-promise)), and Promises/A+ libraries such as [Q](https://github.com/kriskowal/q) and [when](https://github.com/cujojs/when).

If you have an access token, you can set it doing:

spotifyApi.setAccessToken('<here_your_access_token>');

When you set an access token, it will be used for signing your requests. An access token is required for all endpoints.

If you want to use a Promises/A+ library, you can set it:

Here you see how to get basic information using a function like `getArtistAlbums`:

// get Elvis' albums, passing a callback. When a callback is passed, no Promise is returned

spotifyApi.getArtistAlbums('43ZHCT0cAZBISjO8DG9PnE', function (err, data) {

  else console.log('Artist albums', data);

// get Elvis' albums, using Promises through Promise, Q or when

spotifyApi.getArtistAlbums('43ZHCT0cAZBISjO8DG9PnE').then(

The promises also expose an `abort` method that aborts the XMLHttpRequest. This is useful to cancel

requests that were made earlier and could be resolved out-of-sync:

  // store the current promise in case we need to abort it

  prev = spotifyApi.searchTracks(queryTerm, { limit: 5 });

      // clean the promise so it doesn't call abort

      // ...render list of search results...

The functions that fetch data from the API support also an optional JSON object with a set of options, such as the ones regarding pagination. These options will be sent as query parameters:

// passing a callback - get Elvis' albums in range [20...29]

// Type definitions for The Spotify Web API (including changes March 29th 2016)

// Project: https://developer.spotify.com/web-api/

// Definitions by: Niels Kristian Hansen Skovmand <https://github.com/skovmand>

// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

// The audio analysis object is not yet in the Object Model at Spotify, therefore it is typed as any in this file.

// TrackObjects and AlbumObjects is specified in the docs as always having the available_markets property,

// but when it is sent in https://developer.spotify.com/web-api/console/get-current-user-saved-tracks

// the available_markets are missing. Therefore it is marked as optional in this source code.

   * Object for search parameters for searching for tracks, playlists, artists or albums.

   * See: [Search for an item](https://developer.spotify.com/web-api/search-item/)

   * q and type are not optional in the API, however they are marked as optional here, since various libraries

   * implement them as function call parameters instead. This could be changed.

   * @param q Required. The search query's keywords (and optional field filters and operators).

   * @param type Required. A comma-separated list of item types to search across. Valid types are: album, artist, playlist, and track.

   * @param market Optional. An ISO 3166-1 alpha-2 country code or the string from_token

   * @param limit Optional. The maximum number of results to return. Default: 20. Minimum: 1. Maximum: 50.

   * @param offset Optional. The index of the first result to return. Default: 0 (i.e., the first result). Maximum offset: 100.000. Use with limit to get the next page of search results.

  interface SearchForItemParameterObject {

   * Object for use in Recommendations Based on Seeds.

   * See: [Recommendations Based on Seeds](https://developer.spotify.com/web-api/get-recommendations/)

   * @limit q Optional. The target size of the list of recommended tracks. For seeds with unusually small pools or when highly restrictive filtering is applied, it may be impossible to generate the requested number of recommended tracks. Debugging information for such cases is available in the response. Default: 20. Minimum: 1. Maximum: 100.

   * @market q Optional. An ISO 3166-1 alpha-2 country code. Provide this parameter if you want to apply Track Relinking. Because min_*, max_* and target_* are applied to pools before relinking, the generated results may not precisely match the filters applied. Original, non-relinked tracks are available via the linked_from attribute of the relinked track response.

   * @max_ q Optional. Multiple values. For each tunable track attribute, a hard ceiling on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, max_instrumentalness=0.35 would filter out most tracks that are likely to be instrumental.

   * @min_ q Optional. Multiple values. For each tunable track attribute, a hard floor on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, min_tempo=140 would restrict results to only those tracks with a tempo of greater than 140 beats per minute.

   * @seed_artists q A comma separated list of Spotify IDs for seed artists. Up to 5 seed values may be provided in any combination of seed_artists, seed_tracks and seed_genres.

   * @seed_genres q A comma separated list of any genres in the set of available genre seeds. Up to 5 seed values may be provided in any combination of seed_artists, seed_tracks and seed_genres.

   * @seed_tracks q A comma separated list of Spotify IDs for a seed track. Up to 5 seed values may be provided in any combination of seed_artists, seed_tracks and seed_genres.

   * @target_ q Optional. Multiple values. For each of the tunable track attributes (below) a target value may be provided. Tracks with the attribute values nearest to the target values will be preferred. For example, you might request target_energy=0.6 and target_danceability=0.8. All target values will be weighed equally in ranking results.

  interface RecommendationsOptionsObject {

    seed_artists?: string[] | string; // Array of strings or Comma separated string

    seed_genres?: string[] | string; // Array of strings or Comma separated string

    seed_tracks?: string[] | string; // Array of strings or Comma separated string

  interface TrackRelinkingParameterObject {

  interface DeviceSpecificParameterObject {

  // Responses from the Spotify Web API in the same order as in the API endpoint docs seen here:

  // [API Endpoint Reference](https://developer.spotify.com/web-api/endpoint-reference/)

   * https://developer.spotify.com/web-api/get-album/

  interface SingleAlbumResponse extends AlbumObjectFull {}

   * https://developer.spotify.com/web-api/get-several-albums/

   * https://developer.spotify.com/web-api/get-albums-tracks/

  interface AlbumTracksResponse extends PagingObject<TrackObjectSimplified> {}

   * https://developer.spotify.com/web-api/get-artist/

  interface SingleArtistResponse extends ArtistObjectFull {}

   * https://developer.spotify.com/web-api/get-several-artists/

   * https://developer.spotify.com/web-api/get-artists-albums/

  interface ArtistsAlbumsResponse extends PagingObject<AlbumObjectSimplified> {}

   * https://developer.spotify.com/web-api/get-artists-top-tracks/

		{
		"name": "spotify-web-api-js",
		"description": "A client-side JS wrapper for the Spotify Web API",
		"version": "1.4.1",
		"version": "1.5.0",
		"homepage": "https://github.com/JMPerez/spotify-web-api-js",
		@@ -17,11 +17,11 @@ "author": {
		"devDependencies": {
		"coveralls": "^3.0.2",
		"eslint": "^6.2.2",
		"eslint-config-prettier": "^6.10.1",
		"coveralls": "^3.1.0",
		"eslint": "^6.8.0",
		"eslint-config-prettier": "^6.11.0",
		"husky": "^4.2.5",
		"jest": "^25.3.0",
		"lint-staged": "^10.1.5",
		"jest": "^25.5.3",
		"lint-staged": "^10.2.2",
		"prettier": "2.0.5",
		"q": "^1.4.1",
		"sinon": "^9.0.0"
		"sinon": "^9.0.2"
		},
		@@ -28,0 +28,0 @@ "jest": {

		@@ -84,2 +84,3 @@ # Spotify Web API JS [![Build Status](https://travis-ci.org/JMPerez/spotify-web-api-js.svg?branch=master)](https://travis-ci.org/JMPerez/spotify-web-api-js) [![Coverage Status](https://coveralls.io/repos/JMPerez/spotify-web-api-js/badge.svg)](https://coveralls.io/r/JMPerez/spotify-web-api-js) [![Greenkeeper badge](https://badges.greenkeeper.io/JMPerez/spotify-web-api-js.svg)](https://greenkeeper.io/)
		- Toggle shuffle for user's playback
		- Queue a track or an episode

		@@ -86,0 +87,0 @@ ## Installation

		@@ -114,2 +114,6 @@ // Type definitions for The Spotify Web API (including changes March 29th 2016)

		interface QueueParameterObject {
		device_id?: string;
		}

		interface TrackRelinkingParameterObject {
		@@ -116,0 +120,0 @@ market?: string;

Improved metrics