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 i spotify-api-wrapper --save
How to use
ES6
// to import a specific method; // to import everything;
CommonJS
var spotifyWrapper = ;
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 albums = spotifyWrapper;
Methods
Follow the methods that the library provides.
search(query, types)
Search for informations about artists, albums, tracks or playlists. Test in Spotify Web Console.
Arguments
Argument | Type | Options |
---|---|---|
query |
string | 'Any search query' |
type |
Array of strings | ['artist', 'album', 'track', 'playlist'] |
Example
searchAlbums(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
searchArtists(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
searchTracks(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
searchPlaylists(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
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
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
getAlbumTracks(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
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
Diego M. G. Vieira |
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