API Documentation

RESTful APIs from the contents of the El Göose.net database. Current API version is v1.

All valid requests to the API will begin with https://elgoose.net/api/v1.

Methods

  • setlists - display all setlist data
  • latest - display most recent show setlist data
  • shows - display all show data
  • songs - display all song data
  • venues - display all venue data
  • jamcharts - display all jam chart data

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.

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

Available formats are JSON (.json), XML (.xml), and HTML (.html).

Examples

The following are valid URLs to call the API:

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.".

If you use the XML format – you will end up with an empty results node.

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.

Credits

Parts of the API code are based on DB-to-API. The source code for the API is available upon request per the GPL license of the source material.