The current version of the Songfish Demo! API version is v1
.
All valid requests to the API will begin with https://demo.songfishapp.com/api/v1.
setlists
- display all setlist datalatest
- display most recent show setlist datashows
- display all show datasongs
- display all song datavenues
- display all venue datajamcharts
- display all jam chart data/[version]/[method].[format]
/[version]/[method]/[ID].[format]
/[version]/[method]/[column]/[value].[format]
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 may be passed via query string:
order_by
: name of column to sort bydirection
: direction to sort, either asc
or desc
(default asc
)limit
: number, maximum number of results to returne.g., /[version]/[method]/[column]/[value].[format]?order_by=[column]&direction=[direction]
Available formats are JSON (.json), XML (.xml), and HTML (.html).
The following are valid URLs to call the API:
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.
Songfish API is based on ApiFish, which itself is a fork of DB-to-API. The source code for the API is available upon request per the GPL license of the source material.