Additional Input Parameters

Parameter

Type

Category

Description

id

string

optional

If provided, the search results are filtered by the event ID.

keyword

string

optional

This is a keyword on which the search is performed.

attractionId

string

optional

If provided, the search results are filtered by the attraction ID.

venueId

string

optional

If provided, the search results are filtered by the venue ID.

postalCode

string

optional

If provided, the search results are filtered by the postal code or the zip code.

latlong

string

optional

If provided, the search results are filtered by latitude and longitude. This filter is deprecated and may be removed in a future release in favor of geoPoint.

radius

string

optional

This is the radius of the area in which we want to search for events.

unit

enum['miles', 'km']

optional

This is the unit of the radius. The default value is miles.

source

enum['ticketmaster', 'universe', 'frontgate', 'tmr']

optional

If provided, the search results are filtered by their primary source name or publishing source name.

locale

string

optional

This is 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 *, it matches all locales. The default value is en.

marketId

string

optional

If provided, the search results are filtered by the market ID.

startDateTime

string

optional

If provided, the search results are filtered to return events with a start date after this date.

endDateTime

string

optional

If provided, the search results are filtered to return events with a start date before this date.

includeTBA

enum['yes', 'no', 'only']

optional

If yes, events with a date yet to be announced (TBA) are included. If only, only events with a TBA date are returned.

includeTBD

enum['yes', 'no', 'only']

optional

If yes, events with a date yet to be defined (TBD) are included. If only, only events with a TBD date are returned.

includeTest

enum['yes', 'no', 'only']

optional

If yes, events flagged as test are included in the response. If only, only test entities will be returned.

size

number

optional

This is the number of results to be returned per page. The default value is 20.

page

number

optional

This is the page number to be returned. The default value is 0.

sort

string

optional

This is the sorting order of the search results. Allowable values are 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, distance,date,asc, onSaleStartDate,asc, id,asc, venueName,asc, venueName,desc, random. The default value is relevance,desc.

onsaleStartDateTime

string

optional

If provided, the search results are filtered to return events with an onsale start date after this date.

onsaleEndDateTime

string

optional

If provided, the search results are filtered to return events with an onsale start date before this date.

city

string

optional

If provided, the search results are filtered on the city.

countryCode

string

optional

If provided, the search results are filtered on the country.

stateCode

string

optional

If provided, the search results are filtered on the state code.

classificationName

array[string]

optional

If provided, the search results are filtered by classification name, that is, the name of any segment, genre, sub-genre, type, or sub-type. Negative filtering is supported by using the - format. (Negative filters may cause decreased performance.)

classificationId

array[string]

optional

If provided, the search results are filtered by classification ID, that is, the ID of any segment, genre, sub-genre, type, or sub-type. Negative filtering is supported by using the - format. (Negative filters may cause decreased performance.)

dmaId

string

optional

If provided, the search results are filtered on the DMA ID.

localStartDateTime

array[string]

optional

If provided, the search results are filtered to return events with a local start date within this range.

localStartEndDateTime

array[string]

optional

If provided, the search results are filtered to return events with a local start and end date within this range.

startEndDateTime

array[string]

optional

If provided, the search results are filtered to return events with a start and end date within this range.

publicVisibilityStartDateTime

array[string]

optional

If provided, the search results are filtered to return events with public visibility starting from this date.

preSaleDateTime

array[string]

optional

If provided, the search results are filtered to return events with a presale start date within this date.

onsaleOnStartDate

string

optional

If provided, the search results are filtered to return events with an onsale start date on this date.

onsaleOnAfterStartDate

string

optional

If provided, the search results are filtered to return events with an onsale range within this date.

collectionId

array[string]

optional

If provided, the search results are filtered on the collection IDs.

segmentId

array[string]

optional

If provided, the search results are filtered on the segment IDs.

segmentName

array[string]

optional

If provided, the search results are filtered on the segment names.

includeFamily

enum['yes', 'no', 'only']

optional

If yes, events that are family-friendly are included. If only, only family-friendly events are returned.

promoterId

string

optional

If provided, the search results are filtered on the promoter ID.

genreId

array[string]

optional

If provided, the search results are filtered on the genre ID.

subGenreId

array[string]

optional

If provided, the search results are filtered on the sub-genre IDs.

typeId

array[string]

optional

If provided, the search results are filtered on the type IDs.

subTypeId

array[string]

optional

If provided, the search results are filtered on the sub-type IDs.

geoPoint

string

optional

If provided, the search results are filtered on the geohash.

preferredCountry

enum['us', 'ca']

optional

This is the preferred country to find events in. The default value is us.

includeSpellcheck

enum['yes', 'no']

optional

If yes, spell check suggestions are included in the response.

domain

array[string]

optional

If provided, the search results are filtered based on the domain they are available on.