Class FollowApi

Check to see if one or more Spotify users are following a specified playlist.

Required Scopes: playlist-read-private when checking if the current user is privately following a playlist.

example

const response = await spotify.follow.areFollowingPlaylist(
  '7fdQkum2nvXwcaCKnBZ7rR',
  ['griegs', 'jmperezperez'],
);
console.log(response);
// Array [ true, false ]

Add the current user as a follower of an artist.

Required Scopes: user-follow-modify.

example

await spotify.follow.followArtist('029y4wr8YYFoqPBahe8Ddz');

Add the current user as a follower of one or more artists.

Required Scopes: user-follow-modify.

example

await spotify.follow.followArtists([
  '029y4wr8YYFoqPBahe8Ddz',
  '1SlPJ2l80sMnCHpz1wB8nT',
]);

Add the current user as a follower of a playlist.

Required Scopes: playlist-modify-public when publicly following a playlist. playlist-modify-private when privately following a playlist.

example

await spotify.follow.followPlaylist('0USISVmfwjRpmY980WkNW4');

Add the current user as a follower of a Spotify user.

Required Scopes: user-follow-modify.

example

await spotify.follow.followUser('griegs');

Add the current user as a follower of one or more Spotify users.

Required Scopes: user-follow-modify.

example

await spotify.follow.followUsers(['griegs', 'jmperezperez']);

Get the current user's followed artists.

Required Scopes: user-follow-read.

example

const artists = await spotify.follow.getFollowedArtists();
console.log(artists.items.map(item => item.name));
// Array [ "Common Market", "Teebs", "Mount Kimbie", ... ]

Check to see if the current user is following an artist.

Required Scopes: user-follow-read.

example

const response = await spotify.follow.isFollowingArtist(
  '7rZjYMRC5pTV089WKn1Y4s',
);
console.log(response);
// true

Check to see if the current user is following one or more artists.

Required Scopes: user-follow-read.

example

const response = await spotify.follow.isFollowingArtists([
  '2leze82lbuNUn3K4c7nS1B',
  '77bG3jpmWXOxpmZcVjPayy',
]);
console.log(response);
// Array [ true, false ]

Check to see if a Spotify user is following a specified playlist.

Required Scopes: playlist-read-private when checking if the current user is privately following a playlist.

example

const response = await spotify.follow.isFollowingPlaylist(
  '4xOF7TTAG2McFFJDixc3Lt',
  'griegs',
);
console.log(response);
// true

Check to see if the current user is following a Spotify user.

Required Scopes: user-follow-read.

example

const response = await spotify.follow.isFollowingUser('griegs');
console.log(response);
// true

Check to see if the current user is following one or more Spotify users.

Required Scopes: user-follow-read.

example

const response = await spotify.follow.isFollowingUsers([
  'griegs',
  'jmperezperez',
]);
console.log(response);
// Array [ true, true ]

Remove the current user as a follower of an artist.

Required Scopes: user-follow-modify.

example

await spotify.follow.unfollowArtist('3bU97PoqnxjKD45CrfwmC9');

Remove the current user as a follower of one or more artists.

Required Scopes: user-follow-modify.

Remove the current user as a follower of a playlist.

Required Scopes: playlist-modify-public when unfollowing a publicly followed playlist. playlist-modify-private when unfollowing a privately followed playlist.

example

await spotify.follow.unfollowPlaylist('6SAtV2bMjUbQTV37X51F3u');

Remove the current user as a follower of a Spotify user.

Required Scopes: user-follow-modify.

example

await spotify.follow.unfollowUser('griegs');

Remove the current user as a follower of one or more Spotify users.

Required Scopes: user-follow-modify.

example

await spotify.follow.unfollowUsers(['griegs', 'jmperezperez']);