Members
-
spotify :Spotify
-
Description
The spotify client.
Details
Methods
-
get( id ) → {Promise.<(Artist|HTTPError|ApiError)>}
-
Description
Get Spotify catalog information for a single artist identified by their unique Spotify ID.
Parameters
Name Type Description idstring The Spotify ID of the artist.
Returns
Details
-
follow( ids ) → {Promise.<(Status|HTTPError|ApiError)>}
-
Description
Add the current user as a follower of one or more artists.
Parameters
Name Type Description idsstring | Array.<string> The Spotify ID of the artist.
Returns
Details
-
unfollow( ids ) → {Promise.<(Status|HTTPError|ApiError)>}
-
Description
Remove the current user as a follower of one or more artists.
Parameters
Name Type Description idsstring | Array.<string> The Spotify ID of the artist.
Returns
Details
-
following( ids, users ) → {Array.<boolean>|HTTPError|ApiError}
-
Description
Check to see if the current user is following one or more artists.
Parameters
Name Type Description idsstring The Spotify ID of the artist.
usersstring | Array.<string> A list of Spotify User IDs.
Returns
Details
-
top( id, country ) → {Promise.<(Array.<Track>|HTTPError|ApiError)>}
-
Description
Get Spotify catalog information about an artist's top tracks by country.
Parameters
Name Type Description idstring The Spotify ID of the artist.
countrystring An ISO 3166-1 alpha-2 country code.
Returns
Details
-
related( id ) → {Promise.<(Array.<Artist>|HTTPError|ApiError)>}
-
Description
Get Spotify catalog information about artists similar to a given artist.
Parameters
Name Type Description idstring The Spotify ID of the artist.
Returns
Details
-
search( query, options ) → {Promise.<(Array.<Artist>|HTTPError|ApiError)>}
-
Description
Get Spotify catalog information about artists.
Parameters
Name Type Description querystring Your search query.
optionsSearchOptions Returns
Details