- Search API
- Browse API
- Albums API
- Artists API
- Tracks API
- Shows API
- Episodes API
- User API
- Markets API
Using NPM:
npm install --save spotifyx
Using Yarn:
yarn add spotifyx
CommonJS
const Spotify = require("spotifyx");ES6
import Spotify from "spotifyx";import Spotify from "spotifyx";
(async () => {
const client = new Spotify({
clientId: "a-cool-id",
clientSecret: "a-cool-secret",
});
await client.login();
console.log(await client.search("Null Magma", ["artist"]));
})();Key:
- 🄲 – Class declaration
- 🄿 – Property
- 🄼 – Method
Most typedefs are from Spotify's documentation.
🄲 Spotify
Constructs a new Spotify API client.
credentials– Client credentials to log inclientId– Client IDclientSecret– Client secretredirectUrl?– URL to redirect to
Spotify– The newly created client
const client = new Spotify({
clientId: "a-cool-id",
clientSecret: "a-cool-secret",
});readonly string
The client's current access token
Browser
The client's Spotify browse API
Artists
The client's Spotify artists API
Albums
The client's Spotify albums API
Tracks
The client's Spotify tracks API
Episodes
The client's Spotify episodes API
Shows
The client's Spotify shows API
Logs the client in and creates an access token.
string– The newly created access token
await client.login();Searches Spotify using Spotify's search API.
query– Search querytypes– Object types to search foroptions?– Search optionsmarket?– Market to search withinlimit?– Search results limitoffset?– Search results offsetincludeExternal?– Include externals in results
SearchResponse– Search results
const results = await client.search("Null Magma", ["artist"]);Obtains a user from Spotify using an ID.
id– The user's ID
PublicUserObject?– User obtained from the user ID, or undefined if no user was found
const user = await client.user("a-cool-id");Gets all the markets.
string[]– All markets
const markets = await client.markets();🄲 Browser
Wrapper for Spotify's browse API.
private
Fetches newest releases.
options?– Fetch optionscountry?– Country codelimit?– Fetch limitoffset?– Fetch offset
BrowseNewReleasesResponse– Fetched new releases
const releases = await client.browse.newReleases({
limit: 25,
offset: 25,
});Fetches featured playlists.
options?– Fetch optionscountry?– Country codelocale?– Localetimestamp?– Timestamplimit?– Fetch limitoffset?– Fetch offset
BrowseFeaturedPlaylistsResponse– Fetched featured playlists
const playlists = await client.browse.featuredPlaylists();Fetches all categories.
options?– Fetch optionscountry?– Country codelocale?– Localelimit?– Fetch limitoffset?– Fetch offset
BrowseAllCategoriesResponse– Fetched categories
const categories = await client.browse.allCategories();Fetches a category.
category– The categoryoptions?– Fetch optionscountry?– Country codelocale?– Locale
BrowseCategoryResponse– Fetched categories
const category = await client.browse.category("party");Fetches a category's playlists.
category– The categoryoptions?– Fetch optionscountry?– Country code
limit?– Fetch limitoffset?– Fetch offset
PagingObject<SimplifiedPlaylistObject>– Fetched playlists
const playlists = await client.browse.categoryPlaylists("party");Fetches a category's playlists.
seeds– Seedsartists– Seed artistsgenres– Seed genrestracks- Seed tracks
options?– Fetch options- Not available
BrowseRecommendationsResponse– Fetched category platlists
Not available
Fetches recommendation genres.
string[]– Fetched genres
const genres = await client.browse.recommendationGenres();🄲 Artists
Wrapper for Spotify's artists API.
private
Retrieves an artist or multiple artists.
ids– Can either be an ID or array of IDs.
If a single ID is used:
ArtistsSingleArtistResponse– The artist retrieved
If an array of IDs is used:
ArtistsMultipleArtistsResponse– The artists retrieved
const artists = await client.artists.get(["a-id", "another-id"]);Retrieves an artist's top tracks.
id– Artist ID
ArtistsTopTracksResponse– The artist's top tracks
const topTracks = await client.artists.topTracks("an-id");Retrieves an artist's related artists.
id– Artist ID
ArtistsRelatedArtistsResponse– The artist's related artists
const related = await client.artists.related("an-id");Retrieves an artist's albums.
id– Artist ID
ArtistsAlbumsResponse– The artist's albums
const albums = await client.artists.albums("an-id");🄲 Albums
Wrapper for Spotify's shows API.
private
Retrieves an album or multiple albums.
ids– Can either be an ID or array of IDs.options?– Fetch optionsmarket?– Country code
If a single ID is used:
AlbumsSingleAlbumResponse– The album retrieved
If an array of IDs is used:
AlbumsMultipleAlbumsResponse– The albums retrieved
const albums = await client.albums.get(["an-id", "another-id"]);Retrieves an album's tracks.
id– The album's IDoptions?– Fetch optionsmarket– Country codelimit– Fetch limitoffset– Fetch offset
AlbumsTracksResponse– The album's tracks
const tracks = await client.albums.tracks("an-id");🄲 Tracks
Wrapper for Spotify's tracks API.
private
Retrieves a track or multiple tracks.
ids– Can either be an ID or array of IDs.options?– Fetch optionsmarket?– Country code
If a single ID is used:
TracksSingleTrackResponse– The track retrieved
If an array of IDs is used:
TracksMultipleTracksResponse– The tracks retrieved
Retrieves a track or multiple tracks' audio features.
ids– Can either be an ID or array of IDs.options?– Fetch optionsmarket?– Country code
If a single ID is used:
TracksSingleTrackAudioFeatureResponse– The audio feature retrieved
If an array of IDs is used:
TracksMultipleTracksAudioFeaturesResponse– The audio features retrieved
Retrieves a track's audio analysis
id– Track ID
AudioAnalysisObject– The audio analysis
🄲 Episodes
Wrapper for Spotify's episodes API.
private
Retrieves an episode or multiple episodes.
ids– Can either be an ID or array of IDs.options?– Fetch optionsmarket?– Country code
If a single ID is used:
EpisodesSingleEpisodeResponse– The episode retrieved
If an array of IDs is used:
EpisodesMultipleEpisodesResponse– The episodes retrieved
🄲 Shows
Wrapper for Spotify's shows API.
private
Retrieves a show or multiple shows.
ids– Can either be an ID or array of IDs.options?– Fetch optionsmarket?– Country code
If a single ID is used:
ShowsSingleShowResponse– The show retrieved
If an array of IDs is used:
ShowsMultipleShowsResponse– The shows retrieved
const shows = await client.shows.get(["an-id", "another-id"]);Retrieves a show's episodes.
id– The show's ID
ShowsEpisodesResponse– The episodes retrieved
const episodes = await client.shows.episodes("an-id");- Include other three authorization flows
- Use refresh tokens
- Spotify user auth service
- Authorization scopes
- Access to user-related APIs
- Access to other APIs