Project

setlistfm

0.0
No commit activity in last 3 years
No release in over 3 years
setlist.fm API client library
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 2.1.4
~> 0.13.1
~> 13.0.1
~> 3.9.0
~> 0.84.0
~> 3.8.3

Runtime

~> 1.0.1
~> 4.1.0
 Project Readme

Setlistfm Build Status

setlist.fm API client library.

Installation

$ gem install setlistfm

Usage

require 'setlistfm'

Setting API key

You must set the API key.

Please refer to the official API documentation on how to get API key.

setlistfm = Setlistfm.new('your_api_key')

If environment variable SETLISTFM_API_KEY is set in .bash_profile etc, no argument is necessary.

export SETLISTFM_API_KEY=your_api_key
setlistfm = Setlistfm.new

change API key

setlistfm.api_key = 'new_api_key'

API URL

get API URL

setlistfm.url # https://api.setlist.fm

change API URL

setlistfm.url = 'http://example.com'

API version

get API version

setlistfm.api_version # 1.0

change API version

Usually you do not need to change. Use it if the API version is up.

setlistfm.api_version = '1.1'

API Resources

It supports resources of setlist.fm API version 1.0. Please refer to the official API documentation for available parameters etc.

setlistfm.artist('27e2997f-f7a1-4353-bcc4-57b9274fa9a4')
setlistfm.artist_setlists('27e2997f-f7a1-4353-bcc4-57b9274fa9a4', {p: 2})
setlistfm.city(5357527)
setlistfm.search_artists({artistName: 'BABYMETAL'})
setlistfm.search_cities({country: 'US'})
setlistfm.search_countries
setlistfm.search_setlists({artistMbid: '27e2997f-f7a1-4353-bcc4-57b9274fa9a4'})
setlistfm.search_venues({name: 'US'})
setlistfm.setlist_version('6bd6ca6e')
setlistfm.setlist('6bd6ca6e')
setlistfm.user('hondallica')
setlistfm.user_attended('hondallica')
setlistfm.user_edited('hondallica')
setlistfm.venue('6bd6ca6e')
setlistfm.venue_setlists('6bd6ca6e')

License

The gem is available as open source under the terms of the MIT License.