spotify-web-api-node

The library is a universal wrapper/client for the Spotify Web API that works in Node.js and the browser (via browserify, webpack, or rollup). It provides helper functions for:

• Music Metadata: Fetching albums, artists, tracks, audio features, and analysis.
• Profiles: Accessing user emails, product types, display names, and images.
• Search: Searching for albums, artists, tracks, and playlists.
• Playlist Manipulation: Creating, modifying, and managing tracks within playlists.
• Your Music Library: Managing tracks and albums in a user's library.
• Personalization: Retrieving top artists and tracks.
• Browse: Accessing new releases, featured playlists, categories, and recommendations.
• Player Control: Managing playback state, devices, volume, shuffle, repeat, and queue.
• Follow: Following/unfollowing users, artists, and playlists.
• Shows: Accessing podcast show information.

The wrapper supports both Promises and traditional callbacks.

Using Promises: Provide a success callback and an error callback to the .then() method. The response object contains body, headers, and statusCode.

Using Callbacks: If you use a callback, you must provide an options object as the second argument, even if it is empty ({}).

Many methods accept an options object for pagination, such as limit and offset.

// Using Promises
spotifyApi.getArtistAlbums('43ZHCT0cAZBISjO8DG9PnE').then(
  function(data) {
    console.log('Artist albums', data.body);
  },
  function(err) {
    console.error(err);
  }
);

// Using Callbacks (options object is REQUIRED)
spotifyApi.getArtistAlbums(
  '43ZHCT0cAZBISjO8DG9PnE',
  { limit: 10, offset: 20 },
  function(err, data) {
    if (err) {
      console.error('Something went wrong!');
    } else {
      console.log(data.body);
    }
  }
);

The Authorization Code flow is used when you need user permissions.

1. Generate Authorization URL: Use createAuthorizeURL(scopes, state) to direct the user to Spotify's Accounts service.
2. Retrieve Access Token: After the user authorizes, they are redirected to your redirectUri with a code query parameter. Use authorizationCodeGrant(code) to exchange this code for an access token and a refresh token.
3. Use Tokens: Set the tokens using setAccessToken(token) and setRefreshToken(token) so they are used in subsequent calls.

var scopes = ['user-read-private', 'user-read-email'],
  redirectUri = 'https://example.com/callback',
  clientId = '5fe01282e44241328a84e7c5cc169165',
  state = 'some-state-of-my-choice';

var spotifyApi = new SpotifyWebApi({
  redirectUri: redirectUri,
  clientId: clientId
});

// 1. Create the authorization URL
var authorizeURL = spotifyApi.createAuthorizeURL(scopes, state);

// 2. Exchange the code (retrieved from redirect) for tokens
var code = 'MQCbtKe23z7YzzS44KzZgjQa621hgSzHN';
spotifyApi.authorizationCodeGrant(code).then(
  function(data) {
    // 3. Set the tokens for future use
    spotifyApi.setAccessToken(data.body['access_token']);
    spotifyApi.setRefreshToken(data.body['refresh_token']);
  },
  function(err) {
    console.log('Something went wrong!', err);
  }
);

You can manage credentials on an existing SpotifyWebApi instance using individual setters, a bulk setter, or by resetting them.

Bulk Set: setCredentials({ accessToken, refreshToken, redirectUri, clientId, clientSecret }) Individual Setters: setAccessToken(), setRefreshToken(), setRedirectURI(), setClientId(), setClientSecret() Getters: getAccessToken(), getRefreshToken(), getRedirectURI(), getClientId(), getClientSecret(), getCredentials() Resetters: resetAccessToken(), resetRefreshToken(), resetRedirectURI(), resetClientId(), resetClientSecret(), resetCredentials()

var spotifyApi = new SpotifyWebApi();

// Set all credentials at the same time
spotifyApi.setCredentials({
  accessToken: 'myAccessToken',
  refreshToken: 'myRefreshToken',
  redirectUri: 'http://www.example.com/test-callback',
  clientId: 'myClientId',
  clientSecret: 'myClientSecret'
});

// Get credentials
console.log('The access token is ' + spotifyApi.getAccessToken());

// Reset all credentials
spotifyApi.resetCredentials();