Spotify Wrapper API

 

A wrapper to work with the Spotify Web API.

Browser Support

This library relies on Fetch API. This API is supported in the following browsers.

!Chrome | !Firefox | !Opera | !Safari | !IE |
--- | --- | --- | --- | --- |
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 for browser or polyfill for Node.

Installation

``sh
$ npm install spotify-wrapper-api --save
`

How to use

$3

`js
// to import a specific method
import SpotifyWrapper from 'spotify-wrapper-api';

const spotify = new SpotifyWrapper({
token: 'YOUR_TOKEN_HERE'
});

// using method
spotify.search.artists('The Beatles');
`

$3

`js
const spotifyWrapper = require('spotify-wrapper-api');

const spotify = new SpotifyWrapper({
token: 'YOUR_TOKEN_HERE'
});
`

$3

`html





`

After that the library will be available to the Global scope as SpotifyWrapper. Example usage as follows:

`js

const spotify = new SpotifyWrapper({
token: 'YOUR_TOKEN_HERE'
});

const albums = spotify.search.albums('Choosen Artist');
`

Methods

> Here are listed all methods that the library provides.

- Search
- albums
- artists
- tracks
- playlists
- Album
- getAlbum
- getAlbums
- getTracks

$3

> 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

`js
spotify.search.albums('The Beatles')
.then(data => {
// do what you want with the data
})
`

$3

> 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

`js
spotify.search.artists('The Beatles')
.then(data => {
// do what you want with the data
})
`

$3

> 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

`js
spotify.search.tracks('Drive')
.then(data => {
// do what you want with the data
})
`

$3

> 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

`js
spotify.search.playlists('Happy')
.then(data => {
// do what you want with the data
})
`

$3

> Search for informations about a specific Album with provided id. Test in Spotify Web Console.

Arguments

| Argument | Type | Options |
|----------|---------|-------------------|
|id |string | 'Specific id'|


Example

`js
spotify.album.getAlbum('4aawyAB9vmqN3uQ7FjRGTy')
.then(data => {
// do what you want with the data
})
`

$3

> 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

`js
spotify.album.getAlbums(['4aawyAB9vmqN3uQ7FjRGTy', '1A2GTWGtFfWp7KSQTwWOyo'])
.then(data => {
// do what you want with the data
})
`

$3

> 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

`js
spotify.album.getTracks('4aawyAB9vmqN3uQ7FjRGTy')
.then(data => {
// do what you want with the data
})
``

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

| !Francisco Knebel|
|:---------------------:|
| Francisco Knebel |

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