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.

| | | | | --- | --- | --- | --- | --- | 84+ ✔ | 79+ ✔ | 69+ ✔ | 13.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

$ yarn add ahm-spotify-api-wrapper

How to use

ES6

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

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

// using  method
spotify.search.artists('Incubus');

CommonJS

const SpotifyWrapper = require('ahm-spotify-api-wrapper').default;

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

UMD in Browser

<!-- to import minified version -->
<script src="ahm-spotify-wrapper.umd.min.js"></script>

After that the library will be available to the Global as SpotifyWrapper. Follow an example:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

artist.getArtist(id)

Search for a specific Artist. Test in Spotify Web Console.

Arguments

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

Example

spotify.artist.getArtist('2Jw4Lrfjnyv2QsDoBgnrAP')
  .then(data => {
    // do what you want with the data
  })

artist.getArtistAlbums(id)

Search all albums of an Artist. Test in Spotify Web Console.

Arguments

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

Example

spotify.artist.getArtistAlbums('2Jw4Lrfjnyv2QsDoBgnrAP')
  .then(data => {
    // do what you want with the data
  })

artist.getArtists(ids)

Search for informations about some Artists with all id's. Test in Spotify Web Console.

Arguments

| Argument | Type | Options | |----------|---------|-------------------| |ids |Array of strings | ['id1', 'id2']|

Example

spotify.artist.getArtists(['2Jw4Lrfjnyv2QsDoBgnrAP', '3qm84nBOXUEQ2vnTfUTTFC'])
  .then(data => {
    // do what you want with the data
  })

track.getTrack(id)

Search a track of an Artist. Test in Spotify Web Console.

Arguments

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

Example

spotify.track.getTrack('3QbPw4Aj3JgqG0In3ZPZ4q')
  .then(data => {
    // do what you want with the data
  })

track.getTracks(ids)

Search tracks of an Artist with all id's. Test in Spotify Web Console.

Arguments

| Argument | Type | Options | |----------|---------|-------------------| |ids |Array of strings | ['id1', 'id2']|

Example

spotify.track.getTracks(['3QbPw4Aj3JgqG0In3ZPZ4q', '7hjAhjnMzpMT9vU54w0LYF'])
  .then(data => {
    // do what you want with the data
  })

playlist.getPlaylist(id)

Search a playlist. Test in Spotify Web Console.

Arguments

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

Example

spotify.playlist.getPlaylist('37i9dQZF1DXcmgCctFhSfI')
  .then(data => {
    // do what you want with the data
  })

playlist.getPlaylistTracks(id)

Search tracks of a playlist. Test in Spotify Web Console.

Arguments

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

Example

spotify.playlist.getPlaylistTracks('37i9dQZF1DXcmgCctFhSfI')
  .then(data => {
    // do what you want with the data
  })

Authors

Augusto Mentz

License

This project is licensed under the MIT License - see the LICENSE.md file for details