Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/terhuerne/setlistfm-js
This is an easy to use, promise based API wrapper for the most recent version of the setlist.fm Web API. Made with love and JavaScript.
https://github.com/terhuerne/setlistfm-js
api api-client api-wrapper nodejs npm-package react react-native setlist setlist-fm
Last synced: 3 months ago
JSON representation
This is an easy to use, promise based API wrapper for the most recent version of the setlist.fm Web API. Made with love and JavaScript.
- Host: GitHub
- URL: https://github.com/terhuerne/setlistfm-js
- Owner: terhuerne
- License: mit
- Created: 2017-07-14T16:18:13.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-30T19:23:08.000Z (about 2 years ago)
- Last Synced: 2024-09-30T13:23:15.375Z (3 months ago)
- Topics: api, api-client, api-wrapper, nodejs, npm-package, react, react-native, setlist, setlist-fm
- Language: JavaScript
- Homepage:
- Size: 72.3 KB
- Stars: 7
- Watchers: 2
- Forks: 2
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/terhuerne/setlistfm-js)
# setlist.fm API Wrapper for Node.js
This is an easy implementation of the setlist.fm API for Node.js and React. To start right away enter the following lines to your command line:
```
npm install setlistfm-js --save
```
This wrapper covers the brand new API of setlist.fm. To use the API, you need an API key of setlist.fm. You can apply for an API key here: [https://www.setlist.fm/settings/api]() (Please note that you need an setlist.fm account to procede)
## Function Reference
One quick information before we start: The whole wrapper is written for a Promise based implementation. And another thing: The whole documentation for the API can be found here, so if you have any questions about allowed search parameters this is your destination:
[https://api.setlist.fm/docs/1.0/index.html#resources]()
Okay, enough said - let's code!
### Setup
```javascript
var setlistfmClient = new setlistfm({
key: "", // Insert your personal key here
format: "json", // "json" or "xml", defaults to "json"
language: "de", // defaults to "en"
});
```
### Get Artist Profile
```javascript
setlistfmClient.getArtist("8538e728-ca0b-4321-b7e5-cff6565dd4c0")
.then(function(artist) {
// Returns the artist profile of Depeche Mode
})
.catch(function(error) {
// Returns error
});
```
### Get Setlists of Artist
```javascript
setlistfmClient.getArtistSetlists("8538e728-ca0b-4321-b7e5-cff6565dd4c0", {
p: 1
})
.then(function(setlists) {
// Returns page one of all Depeche Mode setlists
})
.catch(function(error) {
// Returns error
});
```
### Get City
```javascript
setlistfmClient.getCity("2921466")
.then(function(city) {
// Returns city profile
})
.catch(function(error) {
// Returns error
});
```
### Search for Artists
```javascript
setlistfmClient.searchArtists({
artistName: "Linkin Park"
})
.then(function(results) {
// Returns results of the search
})
.catch(function(error) {
// Returns error
});
```
### Search for Cities
```javascript
setlistfmClient.searchCities({
name: "New York"
})
.then(function(results) {
// Returns results of the search
})
.catch(function(error) {
// Returns error
});
```
### Search Countries
```javascript
setlistfmClient.searchCountries()
.then(function(results) {
// Returns a list of available countries
})
.catch(function(error) {
// Returns error
});
```
### Search for Setlists
```javascript
setlistfmClient.searchSetlists({
artistName: "Linkin Park"
})
.then(function(results) {
// Returns matching setlists of Linkin Park
})
.catch(function(error) {
// Returns error
});
```
### Search for Venues
```javascript
setlistfmClient.searchVenues({
name: "Gruenspan"
})
.then(function(results) {
// Returns results of the search
})
.catch(function(error) {
// Returns error
});
```
### Get Setlist by specific Version
```javascript
setlistfmClient.getSetlistByVersion("43596f23")
.then(function(setlist) {
// Returns version of setlist
})
.catch(function(error) {
// Returns error
});
```
### Get Setlist
```javascript
setlistfmClient.getSetlist("53e493bd")
.then(function(setlist) {
// Returns setlist
})
.catch(function(error) {
// Returns error
});
```
### Get User
```javascript
setlistfmClient.getUser("terhuerne")
.then(function(user) {
// Returns my own setlist.fm profile ;)
})
.catch(function(error) {
// Returns error
});
```
### Get Concerts a User has attended to
```javascript
setlistfmClient.getUserAttended("terhuerne", {
p: 1
})
.then(function(setlists) {
// Returns setlists of concerts that I have attended to
})
.catch(function(error) {
// Returns error
});
```
### Get Setlists a User has edited
```javascript
setlistfmClient.getUserEdited("terhuerne", {
p: 1
})
.then(function(setlists) {
// Returns setlists that a user has edited
})
.catch(function(error) {
// Returns error
});
```
### Get Venue
```javascript
setlistfmClient.getVenue("4bd78fbe")
.then(function(venue) {
// Returns venue
})
.catch(function(error) {
// Returns error
});
```
### Get Setlists of a Venue
```javascript
setlistfmClient.getVenueSetlists("4bd78fbe", {
p: 1
})
.then(function(setlists) {
// Returns setlists of concerts that have happened at the given venue
})
.catch(function(error) {
// Returns error
});
```