https://github.com/franciscoknebel/spotify-wrapper-api
A Spotify Web API Wrapper, built in JS.
https://github.com/franciscoknebel/spotify-wrapper-api
spotify spotify-wrapper-api
Last synced: about 2 months ago
JSON representation
A Spotify Web API Wrapper, built in JS.
- Host: GitHub
- URL: https://github.com/franciscoknebel/spotify-wrapper-api
- Owner: FranciscoKnebel
- License: mit
- Created: 2017-08-12T20:34:09.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-08-18T05:19:20.000Z (almost 8 years ago)
- Last Synced: 2025-04-03T09:36:05.929Z (about 2 months ago)
- Topics: spotify, spotify-wrapper-api
- Language: JavaScript
- Homepage:
- Size: 147 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Spotify Wrapper API
[](https://travis-ci.org/FranciscoKnebel/spotify-wrapper-api) [](https://coveralls.io/github/FranciscoKnebel/spotify-wrapper-api?branch=master)
A wrapper to work with the [Spotify Web API](https://developer.spotify.com/web-api/).
## Browser Support
This library relies on [Fetch API](https://fetch.spec.whatwg.org/). This API is supported in the following browsers.
 |  |  |  |  |
--- | --- | --- | --- | --- |
39+ ✔ | 42+ ✔ | 29+ ✔ | 10.1+ ✔ | Nope ✘ |
## Dependencies
This library depends on [fetch](https://fetch.spec.whatwg.org/) to make requests to the Spotify Web API.
For environments that don't support fetch, you'll need to provide a [polyfill](https://github.com/github/fetch) for browser or [polyfill](https://github.com/bitinn/node-fetch) for Node.
## Installation
```sh
$ npm install spotify-wrapper-api --save
```
## How to use
### ES6
```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');
```
### CommonJS
```js
const spotifyWrapper = require('spotify-wrapper-api');
const spotify = new SpotifyWrapper({
token: 'YOUR_TOKEN_HERE'
});
```
### UMD in Browser
```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
### search.albums(query)
> Search for informations about Albums with provided query. Test in [Spotify Web Console](https://developer.spotify.com/web-api/console/get-search-item/) 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
})
```
### search.artists(query)
> Search for informations about Artists with provided query. Test in [Spotify Web Console](https://developer.spotify.com/web-api/console/get-search-item/) 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
})
```
### search.tracks(query)
> Search for informations about Tracks with provided query. Test in [Spotify Web Console](https://developer.spotify.com/web-api/console/get-search-item/) 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
})
```
### search.playlists(query)
> Search for informations about Playlist with provided query. Test in [Spotify Web Console](https://developer.spotify.com/web-api/console/get-search-item/) 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
})
```
### album.getAlbum(id)
> Search for informations about a specific Album with provided id. Test in [Spotify Web Console](https://developer.spotify.com/web-api/console/get-album/).
**Arguments**
| Argument | Type | Options |
|----------|---------|-------------------|
|`id` |*string* | 'Specific id'|
**Example**
```js
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](https://developer.spotify.com/web-api/console/get-several-albums/).
**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
})
```
### album.getTracks(id)
> Search for all tracks in a specific Album with provided id. Test in [Spotify Web Console](https://developer.spotify.com/web-api/console/get-album-tracks/).
**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](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/FranciscoKnebel/spotify-wrapper-api/tags).
## Authors
| |
|:---------------------:|
| [Francisco Knebel](https://github.com/FranciscoKnebel/) |
See also the list of [contributors](https://github.com/FranciscoKnebel/spotify-wrapper-api/contributors) who participated in this project.
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details