The setlist.fm API has been designed to give you easy access to setlist data in order to build fancy websites and other applications. Before starting to use the API, be sure to ...
- ... understand how setlist.fm works (the FAQ and the Guidelines are a good starting point),
- ... read this documentation carefully and
- ... apply for an API key (link for logged in users only) - if you're no registered user yet, then register first (it's free).
If this documentation isn't enough or if you've got other things you'd like to tell us about the API, visit the API Forum.
About this Service
This service provides methods to get both setlists and components of setlists such as artists, cities, countries or venues.
Supported Content Types
The REST service currently supports XML (default) and JSON content.
To receive a JSON response, set the
header to application/json.
(Please note that this is an experimental feature and does not work for all cities!)
Most of the featured methods honor the
header. This header is used for
localizing cities and countries. The default language is English (en), but you can provide any of the languages
Spanish (es), French (fr), German (de), Portuguese (pt), Turkish (tr), Italian (it) or Polish (pl).
E.g. if you search a setlist for a concert that took place in Vienna and you pass "de" as header, you'll
get "Wien, Österreich" instead of "Vienna, Austria".
This also works if you use a different language than the country's native language.
E.g. for a concert in New York, you'll get "Nueva York, Estados Unidos" instead of "New York, United States" if you pass "es" as language.
API KeysAPI keys (application form) must be included in the request with the
|Version||Docs||End of Service|
|0.1||December 31, 2017|
API v2 targets v1 functionality with a few minor additions. The API is accessible via https://api.thetvdb.com and provides the following REST endpoints in JSON format.
How to use this API documentation
You may browse the API routes without authentication, but if you wish to send requests to the API and see response data, then you must authenticate.
1. Obtain a JWT token by `POST`ing to the `/login` route in the `Authentication` section with your API key and credentials.
1. Paste the JWT token from the response into the "JWT Token" field at the top of the page and click the 'Add Token' button.
You will now be able to use the remaining routes to send requests to the API and get a response.
Language selection is done via the `Accept-Language` header. At the moment, you may only pass one language abbreviation in the header at a time. Valid language abbreviations can be found at the `/languages` route..
Authentication to use the API is similar to the How-to section above. Users must `POST` to the `/login` route with their API key and credentials in the following format in order to obtain a JWT token.
Note that the username and key are ONLY required for the `/user` routes. The user's key is labled `Account Identifier` in the account section of the main site.
The token is then used in all subsequent requests by providing it in the `Authorization` header. The header will look like: `Authorization: Bearer
Access to the user API is only possible for users with a [premium](http://www.tvmaze.com/premium) account. A user can only access their own user data. Authentication uses HTTP Basic. Use the TVmaze username as authentication username, and the TVmaze API key as authentication password. Your API key can be found on your [dashboard](http://www.tvmaze.com/dashboard). To try out these API calls from this page, click the "Authorize" button on top and input your credentials.