@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Discovery API
@base https://www.ticketmaster.com/discovery/v2
@version v2
@common_fields {locale: any # The locale in ISO code format. Multiple comma-separated values can be provided. When omitting the country part of the code (e.g. only 'en' or 'fr') then the first matching locale is used. When using a '*' it matches all locales. '*' can only be used at the end (e.g. 'en-us,en,*'), includeLicensedContent: any # Yes if you want to display licensed content}
@endpoints 13
@toc discovery(13)

@endpoint GET /discovery/v2/attractions
@desc Attraction Search
@optional {sort: any # Sorting order of the search result. Allowable Values : 'name,asc', 'name,desc', 'relevance,asc', 'relevance,desc', classificationName: any # Filter attractions by classification name: name of any segment, genre, sub-genre, type, sub-type, classificationId: any # Filter attractions by classification id: id of any segment, genre, sub-genre, type, sub-type, keyword: any # Keyword to search on, id: any # Filter entities by its id, source: any # Filter entities by its source name, includeTest: any # True if you want to have entities flag as test in the response. Only, if you only wanted test entities, page: any # Page number, size: any # Page size of the response, includeSpellcheck: any # yes, to include spell check suggestions in the response.}
@returns(200) successful operation

@endpoint GET /discovery/v2/attractions/{id}
@desc Get Attraction Details
@required {id: any # ID of the attraction}
@returns(200) successful operation

@endpoint GET /discovery/v2/classifications
@desc Classification Search
@optional {sort: any # Sorting order of the search result, keyword: any # Keyword to search on, id: any # Filter entities by its id, source: any # Filter entities by its source name, includeTest: any # True if you want to have entities flag as test in the response. Only, if you only wanted test entities, page: any # Page number, size: any # Page size of the response, includeSpellcheck: any # yes, to include spell check suggestions in the response.}
@returns(200) successful operation

@endpoint GET /discovery/v2/classifications/genres/{id}
@desc Get Genre Details
@required {id: any # ID of the genre}
@returns(200) successful operation

@endpoint GET /discovery/v2/classifications/segments/{id}
@desc Get Segment Details
@required {id: any # ID of the segment}
@returns(200) successful operation

@endpoint GET /discovery/v2/classifications/subgenres/{id}
@desc Get Sub-Genre Details
@required {id: any # ID of the subgenre}
@returns(200) successful operation

@endpoint GET /discovery/v2/classifications/{id}
@desc Get Classification Details
@required {id: any # ID of the segment, genre, or sub-genre}
@returns(200) successful operation

@endpoint GET /discovery/v2/events
@desc Event Search
@optional {sort: any # Sorting order of the search result. Allowable values : 'name,asc', 'name,desc', 'date,asc', 'date,desc', 'relevance,asc', 'relevance,desc', 'distance,asc', 'name,date,asc', 'name,date,desc', 'date,name,asc', 'date,name,desc','onsaleStartDate,asc', 'id,asc', startDateTime: any # Filter events with a start date after this date, endDateTime: any # Filter events with a start date before this date, onsaleStartDateTime: any # Filter events with onsale start date after this date, onsaleOnStartDate: any # Filter events with onsale start date on this date, onsaleOnAfterStartDate: any # Filter events with onsale range within this date, onsaleEndDateTime: any # Filter events with onsale end date before this date, city: any # Filter events by city, countryCode: any # Filter events by country code, stateCode: any # Filter events by state code, postalCode: any # Filter events by postal code / zipcode, venueId: any # Filter events by venue id, attractionId: any # Filter events by attraction id, segmentId: any # Filter events by segment id, segmentName: any # Filter events by segment name, classificationName: any # Filter events by classification name: name of any segment, genre, sub-genre, type, sub-type, classificationId: any # Filter events by classification id: id of any segment, genre, sub-genre, type, sub-type, marketId: any # Filter events by market id, promoterId: any # Filter events by promoter id, dmaId: any # Filter events by dma id, includeTBA: any # True, to include events with date to be announce (TBA), includeTBD: any # True, to include event with a date to be defined (TBD), clientVisibility: any # Filter events by clientName, latlong: any # Filter events by latitude and longitude, this filter is deprecated and maybe removed in a future release, please use geoPoint instead, radius: any # Radius of the area in which we want to search for events., unit: any # Unit of the radius, geoPoint: any # filter events by geoHash, keyword: any # Keyword to search on, id: any # Filter entities by its id, source: any # Filter entities by its source name, includeTest: any # True if you want to have entities flag as test in the response. Only, if you only wanted test entities, page: any # Page number, size: any # Page size of the response, includeSpellcheck: any # yes, to include spell check suggestions in the response.}
@returns(200) successful operation

@endpoint GET /discovery/v2/events/{id}
@desc Get Event Details
@required {id: any # ID of the event}
@returns(200) successful operation

@endpoint GET /discovery/v2/events/{id}/images
@desc Get Event Images
@required {id: any # ID of the event}
@returns(200) successful operation

@endpoint GET /discovery/v2/suggest
@desc Find Suggest
@optional {keyword: any # Keyword to search on, source: any # Filter entities by its source name, latlong: any # Filter events by latitude and longitude, this filter is deprecated and maybe removed in a future release, please use geoPoint instead, radius: any # Radius of the area in which we want to search for events., unit: any # Unit of the radius, size: any # Size of every entity returned in the response, includeFuzzy: any # yes, to include fuzzy matches in the search. This has performance impact., clientVisibility: any # Filter events to clientName, countryCode: any # Filter suggestions by country code, includeTBA: any # True, to include events with date to be announce (TBA), includeTBD: any # True, to include event with a date to be defined (TBD), segmentId: any # Filter suggestions by segment id, geoPoint: any # filter events by geoHash, includeSpellcheck: any # yes, to include spell check suggestions in the response.}
@returns(200) successful operation

@endpoint GET /discovery/v2/venues
@desc Venue Search
@optional {sort: any # Sorting order of the search result. Allowable Values: 'name,asc', 'name,desc', 'relevance,asc', 'relevance,desc', 'distance,asc', 'distance,desc', stateCode: any # Filter venues by state / province code, countryCode: any # Filter venues by country code, latlong: any # Filter events by latitude and longitude, this filter is deprecated and maybe removed in a future release, please use geoPoint instead, radius: any # Radius of the area in which we want to search for events., unit: any # Unit of the radius, geoPoint: any # filter events by geoHash, keyword: any # Keyword to search on, id: any # Filter entities by its id, source: any # Filter entities by its source name, includeTest: any # True if you want to have entities flag as test in the response. Only, if you only wanted test entities, page: any # Page number, size: any # Page size of the response, includeSpellcheck: any # yes, to include spell check suggestions in the response.}
@returns(200) successful operation

@endpoint GET /discovery/v2/venues/{id}
@desc Get Venue Details
@required {id: any # ID of the venue}
@returns(200) successful operation

@end
