Get unlimited public & private packages + team-based management with npm Teams.Learn more »

spotify-audio-api

0.1.3 • Public • Published

spotify-audio-api

Spotify Web API wrapper to return audio metadata. This wrapper uses the client credentials auth flow, so only non-user related endpoints can be called.

usage

$ yarn add spotify-audio-api

Instantiate the class with your client ID and client secret provided from the Spotify developer dashboard:

const clientId = 'fsd9f89shfsf2j'
const clientSecret = 'qf9asfsdgh9osgh9sa2'
 
const spotify = new SpotifyAPI(clientId, clientSecret)

This wrapper provides an axios instance with the Spotify API url as the base url.

You can retrieve an auth token with the getToken() method. This method fetches an auth token and sets it as the Authorization header in the axios instance.

spotify.getToken()
 
spotify.instance.get(`/artists/3TVXtAsR1Inumwj472S9r4`).then((response) => console.log(response.data))

API

getToken()

Makes a POST request to the Spotify API and sets the returned token in an axios instance.

getAlbum(albumId, callback)

Get info for a single album.

Params

  • albumId: spotify ID of an album
  • callback: function to handle the returned data

getAlbumTracks(albumId, callback)

Get info on an album's tracks.

Params

  • albumId: spotify ID of an album
  • callback: function to handle the returned data

getArtist(artistId, callback)

Get info on a single artist.

Params

  • artistId: spotify ID of an artist
  • callback: function to handle the returned data

getAlbumsForArtist(artistId, callback)

Get an artist's albums.

Params

  • artistId: spotify ID of an artist
  • callback: function to handle the returned data

getRelatedArtists(artistId, callback)

Get artists related to an artist.

Params

  • artistId: spotify ID of an artist
  • callback: function to handle the returned data

getTrack(trackId, callback)

Get info on a single track.

Params

  • trackId: spotify ID of a track
  • callback: function to handle the returned data

getTrackFeatures(trackId, callback)

Get audio features for a single track/

Params

  • trackId: spotify ID of a track
  • callback: function to handle the returned data

`getTrackAnalysis(trackId, callback)

Get audio analysis for a single track.

Params

  • trackId: spotify ID of a track
  • callback: function to handle the returned data

searchArtists(query, callback)

Search for an artist.

Params

  • query: Search query string
  • callback: function to handle the returned data

searchTracks(query, callback)

Search for a track.

Params

  • query: Search query string
  • callback: function to handle the returned data

searchAlbums(query, callback)

Search for an album/

Params

  • query: Search query string
  • callback: function to handle the returned data

built with skeletor 💀

Install

npm i spotify-audio-api

DownloadsWeekly Downloads

3

Version

0.1.3

License

MIT

Unpacked Size

21.6 kB

Total Files

9

Last publish

Collaborators

  • avatar