Spotify Wrapper
A wrapper to work with the Spotify Web API.
Browser Support
This library relies on Fetch API. And this API is supported in the following browsers.
39+ ✔ | 42+ ✔ | 29+ ✔ | 10.1+ ✔ | Nope ✘ |
Dependencies
This library depends on fetch to make requests to the Spotify Web API. For environments that don't support fetch, you'll need to provide a polyfill to browser or polyfill to Node.
Installation
$ npm install git+https://git@github.com/thulioph/spotify-wrapper.git --save
How to use
ES6
// to import a specific method; const spotify = token: 'YOUR_TOKEN_HERE'; // using methodspotifysearch;
CommonJS
const SpotifyWrapper = default; const spotify = token: 'YOUR_TOKEN_HERE';
UMD in Browser
<!-- to import non-minified version --> <!-- to import minified version -->
After that the library will be available to the Global as SpotifyWrapper
. Follow an example:
const spotify = token: 'YOUR_TOKEN_HERE'; const albums = spotifysearch;
Methods
Follow the methods that the library provides.
search.albums(query)
Search for informations about Albums with provided query. Test in Spotify Web Console with type defined as album.
Arguments
Argument | Type | Options |
---|---|---|
query |
string | 'Any search query' |
Example
spotifysearch
search.artists(query)
Search for informations about Artists with provided query. Test in Spotify Web Console with type defined as artist.
Arguments
Argument | Type | Options |
---|---|---|
query |
string | 'Any search query' |
Example
spotifysearch
search.tracks(query)
Search for informations about Tracks with provided query. Test in Spotify Web Console with type defined as track.
Arguments
Argument | Type | Options |
---|---|---|
query |
string | 'Any search query' |
Example
spotifysearch
search.playlists(query)
Search for informations about Playlist with provided query. Test in Spotify Web Console with type defined as playlist.
Arguments
Argument | Type | Options |
---|---|---|
query |
string | 'Any search query' |
Example
spotifysearch
album.getAlbum(id)
Search for informations about a specific Album with provided id. Test in Spotify Web Console.
Arguments
Argument | Type | Options |
---|---|---|
id |
string | 'Specific id' |
Example
spotifyalbum
album.getAlbums(ids)
Search for informations about some Albums with all id's. Test in Spotify Web Console.
Arguments
Argument | Type | Options |
---|---|---|
ids |
Array of strings | ['id1', 'id2'] |
Example
spotifyalbum
album.getTracks(id)
Search for all tracks in a specific Album with provided id. Test in Spotify Web Console.
Arguments
Argument | Type | Options |
---|---|---|
id |
string | 'Specific id' |
Example
spotifyalbum
audio.analysis(id)
Get a detailed audio analysis for a single track with provided id. Test in Spotify Web Console.
Arguments
Argument | Type | Options |
---|---|---|
id |
string | 'Specific id' |
Example
spotifyaudio
audio.features(id)
Get an audio feature information for a single track with provided id. Test in Spotify Web Console.
Arguments
Argument | Type | Options |
---|---|---|
id |
string | 'Specific id' |
Example
spotifyaudio
user.profile()
Get the current user's profile information. Test in Spotify Web Console.
Example
spotifyuserprofile
user.topArtists()
Get the current user's top artists based on calculated affinity. Test in Spotify Web Console.
Example
spotifyuser
user.topTracks()
Get the current user's top tracks based on calculated affinity. Test in Spotify Web Console.
Example
spotifyuser
user.recomendations(type, id)
Get a list of recomended tracks, artists or genders with provided id. Test in Spotify Web Console.
Arguments
Argument | Type | Options |
---|---|---|
type |
string | 'tracks, artists or genres' |
id |
string | 'Specific id' |
Example
spotifyuser
Contributing
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
Versioning
We use SemVer for versioning. For the versions available, see the tags on this repository.
Authors
Thulio Philipe |
See also the list of contributors who participated in this project.
License
This project is licensed under the MIT License - see the LICENSE.md file for details