API Documentation


The current version of the neighbortunes API version is v2.

All valid requests to the API will begin with https://neighbortunes.net/api/v2. If you use that URL without any further data, it will return HTTP 204, no valid method found.

Methods

  • setlists - display setlist data
  • latest - display most recent show setlist data
  • shows - display show data
  • songs - display song data
  • venues - display venue data
  • jamcharts - display jam chart data
  • albums - display data related to discography
  • metadata - display setlist metadata
  • links - display links attached to shows
  • uploads - display show metadata, including poster art and featured images

API Request Structure

  • all data returned via a method: /[version]/[method].[format]
  • specific row in a method: /[version]/[method]/[ID].[format]
  • all rows matching a query: /[version]/[method]/[column]/[value].[format]

Authentication

There is no authentication for API calls - no token or key is necessary. No data is passed via POST or HEAD requests, only by URI and, optionally, by GET parameters in the query string.

Additional Parameters

Additional parameters may be passed via query string:

  • order_by: name of column to sort by
  • direction: direction to sort, either asc or desc (default asc)
  • limit: number, maximum number of results to return

e.g., /[version]/[method]/[column]/[value].[format]?order_by=[column]&direction=[direction]

Formats

API version 2 data is available in the following formats: JSON (.json) and HTML (.html).

Examples

The following are valid URLs to call the API:

Description URL
https://neighbortunes.net/api/v2/setlists/showyear/2019.json?order_by=showdate shows from 2019
https://neighbortunes.net/api/v2/setlists/songname/Just+A+Closer+Walk+With+Thee.html setlist records of the song "Just A Closer Walk With Thee"
https://neighbortunes.net/api/v2/latest.json?order_by=position&direction=asc latest shows, sorted by position ASC
https://neighbortunes.net/api/v2/shows/show_id/1601987014.html shows with show_id 1601987014
https://neighbortunes.net/api/v2/links/show_id/1601987014.json links attached to show_id 1601987014
https://neighbortunes.net/api/v2/venues.json all venues
https://neighbortunes.net/api/v2/metadata/song_slug/the-bottom-of-my-heart.html metadata related to the song "The Bottom Of My Heart"
https://neighbortunes.net/api/v2/shows/venuename/Thunder+Road.html venues named Thunder Road
https://neighbortunes.net/api/v2/venues/state/MA.html Shows in the state of Massachusetts
https://neighbortunes.net/api/v2/venues/city/Somerville.json Shows in Somerville
https://neighbortunes.net/api/v2/jamcharts/city/Somerville.html Jamchart entries in Somerville
https://neighbortunes.net/api/v2/jamcharts.html All jamchart entries in JSON
https://neighbortunes.net/api/v2/albums.json All album tracks in JSON
https://neighbortunes.net/api/v2/uploads.html All uploads/show metadata in HTML

Error Checking

If your request contains an error, you may end up with unexpected output. If your request URI contains a typos, uses improper case, or requests or sorts by a nonexistent column, you may end up with no data in your response.

If you use the HTML format – an error will display "No results found.".

The JSON format works a bit differently. Every JSON response is has three return nodes: error, error_message, and data. A successful response will contain error 0, a blank error_message, and a data object populated with your response. An error response will contain error 1, a text-based error message, and a blank data object.

Embeds

You can embed a setlist in a remote website via iframe or Javascript. In both cases, a URL is constructed like so: https://neighbortunes.net/api/embed/{arg}.html.

{arg} must be one of the following:

In all cases, the .html extension is optional. Here is example code for a valid embed:

<iframe src="https://neighbortunes.net/api/embed/2019-08-06.html"></iframe>

Another way would be to add the following in <script> tags. Since you won't want a full HTML document, make sure you add headless=1 to the URL:

const response = await fetch('https://neighbortunes.net/api/embed/2019-08-06.html?headless=1');
const body = await response.text();
document.querySelector('#some.selector').innerHTML = body;

or, using jQuery:

$('#some.selector').load('https://neighbortunes.net/api/embed/2019-08-06.html?headless=1');

Powered by Songfish