swagger: '2.0'
info:
description: '
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.
Note that the setlist.fm API is, according to the API terms of
service, only free for non-commercial projects. If you''re interested in using the API for commercial purposes,
contact us.
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 Accept
header to application/json.
Internationalization
(Please note that this is an experimental feature and does not work for all cities!)
Most of the featured methods honor the Accept-Language
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 Keys
API keys (application form) must be included in the request with
the x-api-key header.
Version History
| Version |
Docs |
End of Service |
| 1.0 |
Docs |
-
|
| 0.1 |
|
December 31, 2017
|
'
version: '1.0'
title: setlist.fm /1.0/artist/{mbid} /1.0/artist/{mbid} /1.0/venue/{venueId} API
basePath: /rest
schemes: []
tags:
- name: /1.0/venue/{venueId}
paths:
/1.0/venue/{venueId}:
get:
tags:
- /1.0/venue/{venueId}
summary: Get a venue by its unique id.
description: Get a venue by its unique id.
operationId: resource__1.0_venue__venueId__getVenue_GET
produces:
- application/xml
- application/json
parameters:
- name: venueId
in: path
required: true
type: string
description: the venue's id
responses:
'200':
schema:
description: ''
$ref: '#/definitions/json_Venue'
headers: {}
examples:
application/json:
city:
id: '5357527'
name: Hollywood
stateCode: CA
state: California
coords:
long: -118.3267434
lat: 34.0983425
country:
code: US
name: United States
url: https://www.setlist.fm/venue/compaq-center-san-jose-ca-usa-6bd6ca6e.html
id: 6bd6ca6e
name: Compaq Center
description: Success
definitions:
json_Venue:
type: object
title: venue
properties:
city:
description: the city in which the venue is located
$ref: '#/definitions/json_City'
url:
example: https://www.setlist.fm/venue/compaq-center-san-jose-ca-usa-6bd6ca6e.html
description: the attribution url
type: string
id:
example: 6bd6ca6e
description: unique identifier
type: string
name:
example: Compaq Center
description: 'the name of the venue, usually without city and country. E.g. "Madison Square Garden" or
"Royal Albert Hall"'
type: string
example:
city:
id: '5357527'
name: Hollywood
stateCode: CA
state: California
coords:
long: -118.3267434
lat: 34.0983425
country:
code: US
name: United States
url: https://www.setlist.fm/venue/compaq-center-san-jose-ca-usa-6bd6ca6e.html
id: 6bd6ca6e
name: Compaq Center
description: 'Venues are places where concerts take place. They usually consist of a venue name and a city - but there are also
some venues that do not have a city attached yet. In such a case, the city simply isn''t set and the city and country
may (but do not have to) be in the name.'
json_Country:
type: object
title: country
properties:
code:
example: US
description: 'The country''s ISO code. E.g.
"ie" for Ireland'
type: string
name:
example: United States
description: 'The country''s name. Can be a localized name - e.g. "Austria" or
"Österreich" for Austria if the German name was requested.'
type: string
example:
code: US
name: United States
description: This class represents a country on earth.
json_City:
type: object
title: city
properties:
id:
example: '5357527'
description: unique identifier
type: string
name:
example: Hollywood
description: 'the city''s name, depending on the language valid values are e.g. "Müchen" or
Munich'
type: string
stateCode:
example: CA
description: 'The code of the city''s state. For most countries this is a two-digit numeric code, with which the state can be
identified uniquely in the specific Country. The code can also be a String for other cities. Valid
examples are "CA" or "02"
which in turn get uniquely identifiable when combined with the state''s country:
"US.CA" for California, United States or "DE.02" for Bavaria, Germany
For a complete list of available states (that aren''t necessarily used in this database) is available in
a textfile on geonames.org.
Note that this code is only unique combined with the city''s Country. The code alone is
not unique.'
type: string
state:
example: California
description: The name of city's state, e.g. "Bavaria" or "Florida"
type: string
coords:
description: The city's coordinates. Usually the coordinates of the city centre are used.
$ref: '#/definitions/json_Coords'
country:
description: The city's country.
$ref: '#/definitions/json_Country'
example:
id: '5357527'
name: Hollywood
stateCode: CA
state: California
coords:
long: -118.3267434
lat: 34.0983425
country:
code: US
name: United States
description: 'This class represents a city where Venues are located. Most of the original city data was taken from
Geonames.org.'
json_Coords:
type: object
title: coords
properties:
long:
example: -118.3267434
description: The longitude part of the coordinates.
type: number
lat:
example: 34.0983425
description: The latitude part of the coordinates.
type: number
example:
long: -118.3267434
lat: 34.0983425
description: Coordinates of a point on the globe. Mostly used for Cities.