spotify-audio-api
v0.1.3
Published
Spotify API wrapper to return audio metadata
Downloads
12
Maintainers
Readme
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)
Params
albumId
: spotify ID of an albumcallback
: function to handle the returned data
getAlbumTracks(albumId, callback)
Get info on an album's tracks.
Params
albumId
: spotify ID of an albumcallback
: function to handle the returned data
getArtist(artistId, callback)
Params
artistId
: spotify ID of an artistcallback
: function to handle the returned data
getAlbumsForArtist(artistId, callback)
Params
artistId
: spotify ID of an artistcallback
: function to handle the returned data
getRelatedArtists(artistId, callback)
Get artists related to an artist.
Params
artistId
: spotify ID of an artistcallback
: function to handle the returned data
getTrack(trackId, callback)
Params
trackId
: spotify ID of a trackcallback
: function to handle the returned data
getTrackFeatures(trackId, callback)
Get audio features for a single track/
Params
trackId
: spotify ID of a trackcallback
: function to handle the returned data
`getTrackAnalysis(trackId, callback)
Get audio analysis for a single track.
Params
trackId
: spotify ID of a trackcallback
: function to handle the returned data
searchArtists(query, callback)
Params
query
: Search query stringcallback
: function to handle the returned data
searchTracks(query, callback)
Params
query
: Search query stringcallback
: function to handle the returned data
searchAlbums(query, callback)
Params
query
: Search query stringcallback
: function to handle the returned data
built with skeletor 💀