ticketmaster.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.
New to Corsair? See API access, authentication, and error handling.
Attractions
get
attractions.get
Get one attraction by ID, including its images, classifications and aliases
Risk: read
await corsair.ticketmaster.api.attractions.get({ id: 'K8vZ9171q60' });
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The attraction ID. |
locale | string | No | ISO locale, such as ‘en-us’. Comma-separated values are allowed; ’*’ may end the list. |
domain | string[] | No | Only entities available on these domains, such as ticketmaster.com. |
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
name | string | null | No | — |
type | string | null | No | — |
test | boolean | null | No | — |
url | string | null | No | — |
locale | string | null | No | — |
description | string | null | No | — |
additionalInfo | string | null | No | — |
images | object[] | null | No | — |
classifications | object[] | null | No | — |
aliases | string[] | null | No | — |
localizedAliases | object | null | No | — |
externalLinks | object | null | No | — |
upcomingEvents | object | null | No | — |
_links | object | null | No | — |
images full type
images full type
{
url?: string | null,
ratio?: string | null,
width?: number | null,
height?: number | null,
fallback?: boolean | null
}[]
classifications full type
classifications full type
{
primary?: boolean | null,
family?: boolean | null,
segment?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null,
_embedded?: {
genres?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null,
_embedded?: {
subgenres?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
}[] | null
} | null
}[] | null
} | null
} | null,
genre?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null,
_embedded?: {
subgenres?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
}[] | null
} | null
} | null,
subGenre?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
} | null,
type?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
} | null,
subType?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
} | null
}[]
localizedAliases full type
localizedAliases full type
Record<string, unknown>
externalLinks full type
externalLinks full type
Record<string, unknown>
upcomingEvents full type
upcomingEvents full type
Record<string, unknown>
_links full type
_links full type
Record<string, unknown>
search
attractions.search
Search attractions (artists, teams, shows) by keyword, classification or source, with paging and sorting
Risk: read
await corsair.ticketmaster.api.attractions.search({ keyword: 'coachella', size: 5 });
| Name | Type | Required | Description |
|---|---|---|---|
id | string | No | — |
keyword | string | No | — |
source | string | No | Publishing source, such as ‘ticketmaster’, ‘universe’, ‘frontgate’ or ‘tmr’. |
locale | string | No | ISO locale, such as ‘en-us’. Comma-separated values are allowed; ’*’ may end the list. |
includeTest | 'yes' | 'no' | 'only' | No | — |
includeFamily | 'yes' | 'no' | 'only' | No | — |
includeSpellcheck | 'yes' | 'no' | No | — |
classificationName | string[] | No | — |
classificationId | string[] | No | — |
segmentId | string[] | No | — |
genreId | string[] | No | — |
subGenreId | string[] | No | — |
typeId | string[] | No | — |
subTypeId | string[] | No | — |
sort | string | No | Field and direction, such as ‘name,asc’ or ‘relevance,desc’. Ticketmaster defaults to relevance,desc. |
preferredCountry | 'us' | 'ca' | No | — |
size | number | No | Items per page. Ticketmaster defaults to 20. |
page | number | No | 0-based page number. |
domain | string[] | No | Only entities available on these domains, such as ticketmaster.com. |
| Name | Type | Required | Description |
|---|---|---|---|
attractions | object[] | Yes | — |
page | object | null | No | — |
next_page | number | null | No | The next 0-based page, or null on the last one. Ticketmaster stops at the 1000th item, so this is also null once that limit is reached. |
attractions full type
attractions full type
{
id: string,
name?: string | null,
type?: string | null,
test?: boolean | null,
url?: string | null,
locale?: string | null,
description?: string | null,
additionalInfo?: string | null,
images?: {
url?: string | null,
ratio?: string | null,
width?: number | null,
height?: number | null,
fallback?: boolean | null
}[] | null,
classifications?: {
primary?: boolean | null,
family?: boolean | null,
segment?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null,
_embedded?: {
genres?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null,
_embedded?: {
subgenres?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
}[] | null
} | null
}[] | null
} | null
} | null,
genre?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null,
_embedded?: {
subgenres?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
}[] | null
} | null
} | null,
subGenre?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
} | null,
type?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
} | null,
subType?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
} | null
}[] | null,
aliases?: string[] | null,
localizedAliases?: {
} | null,
externalLinks?: {
} | null,
upcomingEvents?: {
} | null,
_links?: {
} | null
}[]
page full type
page full type
{
size?: number | null,
totalElements?: number | null,
totalPages?: number | null,
number?: number | null
}
Classifications
get
classifications.get
Get one segment, genre or sub-genre by ID, with the level below it
Risk: read
await corsair.ticketmaster.api.classifications.get({ id: 'KZFzniwnSyZfZ7v7nE' });
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | A segment, genre or sub-genre ID. |
locale | string | No | ISO locale, such as ‘en-us’. Comma-separated values are allowed; ’*’ may end the list. |
domain | string[] | No | Only entities available on these domains, such as ticketmaster.com. |
| Name | Type | Required | Description |
|---|---|---|---|
primary | boolean | null | No | — |
family | boolean | null | No | — |
segment | object | null | No | — |
genre | object | null | No | — |
subGenre | object | null | No | — |
type | object | null | No | — |
subType | object | null | No | — |
id | string | null | No | — |
_links | object | null | No | — |
segment full type
segment full type
{
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null,
_embedded?: {
genres?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null,
_embedded?: {
subgenres?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
}[] | null
} | null
}[] | null
} | null
}
genre full type
genre full type
{
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null,
_embedded?: {
subgenres?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
}[] | null
} | null
}
subGenre full type
subGenre full type
{
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
}
type full type
type full type
{
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
}
subType full type
subType full type
{
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
}
_links full type
_links full type
Record<string, unknown>
search
classifications.search
Search the segment, genre and sub-genre tree Ticketmaster uses to classify events and attractions
Risk: read
await corsair.ticketmaster.api.classifications.search({ size: 10 });
| Name | Type | Required | Description |
|---|---|---|---|
id | string | No | — |
keyword | string | No | — |
source | string | No | Publishing source, such as ‘ticketmaster’, ‘universe’, ‘frontgate’ or ‘tmr’. |
locale | string | No | ISO locale, such as ‘en-us’. Comma-separated values are allowed; ’*’ may end the list. |
includeTest | 'yes' | 'no' | 'only' | No | — |
includeSpellcheck | 'yes' | 'no' | No | — |
sort | string | No | Field and direction. Ticketmaster defaults to name,asc. |
preferredCountry | 'us' | 'ca' | No | — |
size | number | No | Items per page. Ticketmaster defaults to 20. |
page | number | No | 0-based page number. |
domain | string[] | No | Only entities available on these domains, such as ticketmaster.com. |
| Name | Type | Required | Description |
|---|---|---|---|
classifications | object[] | Yes | — |
page | object | null | No | — |
next_page | number | null | No | The next 0-based page, or null on the last one. Ticketmaster stops at the 1000th item, so this is also null once that limit is reached. |
classifications full type
classifications full type
{
primary?: boolean | null,
family?: boolean | null,
segment?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null,
_embedded?: {
genres?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null,
_embedded?: {
subgenres?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
}[] | null
} | null
}[] | null
} | null
} | null,
genre?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null,
_embedded?: {
subgenres?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
}[] | null
} | null
} | null,
subGenre?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
} | null,
type?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
} | null,
subType?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
} | null,
id?: string | null,
_links?: {
} | null
}[]
page full type
page full type
{
size?: number | null,
totalElements?: number | null,
totalPages?: number | null,
number?: number | null
}
Events
get
events.get
Get one event by ID, including its dates, sales window, price ranges, images, venue and attractions
Risk: read
await corsair.ticketmaster.api.events.get({ id: 'G5diZfkn0B-bh' });
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The event ID. |
locale | string | No | ISO locale, such as ‘en-us’. Comma-separated values are allowed; ’*’ may end the list. |
domain | string[] | No | Only entities available on these domains, such as ticketmaster.com. |
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
name | string | null | No | — |
type | string | null | No | — |
test | boolean | null | No | — |
url | string | null | No | — |
locale | string | null | No | — |
description | string | null | No | — |
additionalInfo | string | null | No | — |
info | string | null | No | — |
pleaseNote | string | null | No | — |
productType | string | null | No | — |
images | object[] | null | No | — |
dates | object | null | No | — |
sales | object | null | No | — |
priceRanges | object[] | null | No | — |
classifications | object[] | null | No | — |
promoter | object | null | No | — |
promoters | object[] | null | No | — |
outlets | object[] | null | No | — |
products | object[] | null | No | — |
aliases | string[] | null | No | — |
seatmap | object | null | No | — |
accessibility | object | null | No | — |
ticketLimit | object | null | No | — |
place | object | null | No | — |
externalLinks | object | null | No | — |
localizedAliases | object | null | No | — |
_embedded | object | null | No | — |
_links | object | null | No | — |
images full type
images full type
{
url?: string | null,
ratio?: string | null,
width?: number | null,
height?: number | null,
fallback?: boolean | null
}[]
dates full type
dates full type
{
start?: {
localDate?: string | null,
localTime?: string | null,
dateTime?: string | null,
dateTBD?: boolean | null,
dateTBA?: boolean | null,
timeTBA?: boolean | null,
noSpecificTime?: boolean | null
} | null,
end?: {
localDate?: string | null,
localTime?: string | null,
dateTime?: string | null,
approximate?: boolean | null,
noSpecificTime?: boolean | null
} | null,
timezone?: string | null,
spanMultipleDays?: boolean | null,
status?: {
code?: string | null
} | null
}
sales full type
sales full type
{
public?: {
startDateTime?: string | null,
endDateTime?: string | null,
startTBD?: boolean | null,
startTBA?: boolean | null
} | null,
presales?: {
name?: string | null,
description?: string | null,
url?: string | null,
startDateTime?: string | null,
endDateTime?: string | null,
startTBD?: boolean | null,
startTBA?: boolean | null
}[] | null
}
priceRanges full type
priceRanges full type
{
type?: string | null,
currency?: string | null,
min?: number | null,
max?: number | null
}[]
classifications full type
classifications full type
{
primary?: boolean | null,
family?: boolean | null,
segment?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null,
_embedded?: {
genres?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null,
_embedded?: {
subgenres?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
}[] | null
} | null
}[] | null
} | null
} | null,
genre?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null,
_embedded?: {
subgenres?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
}[] | null
} | null
} | null,
subGenre?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
} | null,
type?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
} | null,
subType?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
} | null
}[]
promoter full type
promoter full type
{
id?: string | null
}
promoters full type
promoters full type
{
id?: string | null
}[]
outlets full type
outlets full type
{
href?: string | null,
templated?: boolean | null
}[]
products full type
products full type
{
href?: string | null,
templated?: boolean | null
}[]
seatmap full type
seatmap full type
Record<string, unknown>
accessibility full type
accessibility full type
Record<string, unknown>
ticketLimit full type
ticketLimit full type
Record<string, unknown>
place full type
place full type
Record<string, unknown>
externalLinks full type
externalLinks full type
Record<string, unknown>
localizedAliases full type
localizedAliases full type
Record<string, unknown>
_embedded full type
_embedded full type
{
venues?: {
id: string,
name?: string | null,
type?: string | null,
test?: boolean | null,
url?: string | null,
locale?: string | null,
description?: string | null,
additionalInfo?: string | null,
postalCode?: string | null,
timezone?: string | null,
currency?: string | null,
city?: {
name?: string | null
} | null,
state?: {
name?: string | null,
stateCode?: string | null
} | null,
country?: {
name?: string | null,
countryCode?: string | null
} | null,
address?: {
line1?: string | null
} | null,
location?: {
longitude?: string | number | null,
latitude?: string | number | null
} | null,
markets?: {
id?: string | number | null
}[] | null,
dmas?: {
id?: number | null
}[] | null,
images?: {
url?: string | null,
ratio?: string | null,
width?: number | null,
height?: number | null,
fallback?: boolean | null
}[] | null,
boxOfficeInfo?: {
} | null,
generalInfo?: {
} | null,
social?: {
} | null,
parkingDetail?: string | null,
accessibleSeatingDetail?: string | null,
upcomingEvents?: {
} | null,
_links?: {
} | null
}[] | null,
attractions?: {
id: string,
name?: string | null,
type?: string | null,
test?: boolean | null,
url?: string | null,
locale?: string | null,
description?: string | null,
additionalInfo?: string | null,
images?: {
url?: string | null,
ratio?: string | null,
width?: number | null,
height?: number | null,
fallback?: boolean | null
}[] | null,
classifications?: {
primary?: boolean | null,
family?: boolean | null,
segment?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null,
_embedded?: {
genres?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null,
_embedded?: {
subgenres?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
}[] | null
} | null
}[] | null
} | null
} | null,
genre?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null,
_embedded?: {
subgenres?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
}[] | null
} | null
} | null,
subGenre?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
} | null,
type?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
} | null,
subType?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
} | null
}[] | null,
aliases?: string[] | null,
localizedAliases?: {
} | null,
externalLinks?: {
} | null,
upcomingEvents?: {
} | null,
_links?: {
} | null
}[] | null
}
_links full type
_links full type
Record<string, unknown>
getImages
events.getImages
Get the images for one event by ID, with each ratio, size and URL
Risk: read
await corsair.ticketmaster.api.events.getImages({ id: 'k7vGFKzleBdwS' });
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The event ID. |
locale | string | No | ISO locale, such as ‘en-us’. Comma-separated values are allowed; ’*’ may end the list. |
domain | string[] | No | Only entities available on these domains, such as ticketmaster.com. |
| Name | Type | Required | Description |
|---|---|---|---|
id | string | null | No | — |
type | string | null | No | — |
images | object[] | Yes | — |
images full type
images full type
{
url?: string | null,
ratio?: string | null,
width?: number | null,
height?: number | null,
fallback?: boolean | null
}[]
search
events.search
Search events by keyword, attraction, venue, location, date, classification or onsale window, with paging and sorting
Risk: read
await corsair.ticketmaster.api.events.search({ classificationName: ['music'], countryCode: 'US', city: ['Seattle'], startDateTime: '2026-01-01T00:00:00Z', sort: 'date,asc', size: 10 });
| Name | Type | Required | Description |
|---|---|---|---|
id | string | No | Only this event ID. |
keyword | string | No | Free-text search on the event name. |
attractionId | string | No | Only events by this attraction (artist, team, show). |
venueId | string | No | Only events at this venue. |
postalCode | string | No | — |
latlong | string | No | ’latitude,longitude’. Deprecated by Ticketmaster in favour of geoPoint. |
geoPoint | string | No | Geo hash to search around, with radius and unit. |
radius | number | No | Search radius; the unit is unit. |
unit | 'miles' | 'km' | No | — |
source | string | No | Publishing source, such as ‘ticketmaster’, ‘universe’, ‘frontgate’ or ‘tmr’. Comma-separated values are allowed. |
locale | string | No | ISO locale, such as ‘en-us’. Comma-separated values are allowed; ’*’ may end the list. |
marketId | string | No | — |
dmaId | string | No | — |
startDateTime | string | No | Only events starting at or after this UTC time, such as 2026-01-01T00:00:00Z. |
endDateTime | string | No | Only events starting at or before this UTC time. |
localStartDateTime | string | No | A local-time range as two comma-separated timestamps. |
onsaleStartDateTime | string | No | — |
onsaleEndDateTime | string | No | — |
includeTBA | 'yes' | 'no' | 'only' | No | Date to be announced events. |
includeTBD | 'yes' | 'no' | 'only' | No | Date to be defined events. |
includeTest | 'yes' | 'no' | 'only' | No | — |
includeFamily | 'yes' | 'no' | 'only' | No | — |
includeSpellcheck | 'yes' | 'no' | No | — |
city | string[] | No | — |
countryCode | string | No | ISO country code, such as US. |
stateCode | string | No | US state code, such as NY. |
classificationName | string[] | No | Segment, genre or sub-genre names, such as ‘music’. A ’-‘-prefixed value excludes it. |
classificationId | string[] | No | — |
segmentId | string[] | No | — |
segmentName | string[] | No | — |
genreId | string[] | No | — |
subGenreId | string[] | No | — |
typeId | string[] | No | — |
subTypeId | string[] | No | — |
collectionId | string[] | No | — |
promoterId | string | No | — |
sort | string | No | Field and direction, such as ‘date,asc’ or ‘relevance,desc’. Ticketmaster defaults to relevance,desc. |
preferredCountry | 'us' | 'ca' | No | — |
size | number | No | Items per page. Ticketmaster defaults to 20. |
page | number | No | 0-based page number. |
domain | string[] | No | Only entities available on these domains, such as ticketmaster.com. |
| Name | Type | Required | Description |
|---|---|---|---|
events | object[] | Yes | — |
page | object | null | No | — |
next_page | number | null | No | The next 0-based page, or null on the last one. Ticketmaster stops at the 1000th item, so this is also null once that limit is reached. |
events full type
events full type
{
id: string,
name?: string | null,
type?: string | null,
test?: boolean | null,
url?: string | null,
locale?: string | null,
description?: string | null,
additionalInfo?: string | null,
info?: string | null,
pleaseNote?: string | null,
productType?: string | null,
images?: {
url?: string | null,
ratio?: string | null,
width?: number | null,
height?: number | null,
fallback?: boolean | null
}[] | null,
dates?: {
start?: {
localDate?: string | null,
localTime?: string | null,
dateTime?: string | null,
dateTBD?: boolean | null,
dateTBA?: boolean | null,
timeTBA?: boolean | null,
noSpecificTime?: boolean | null
} | null,
end?: {
localDate?: string | null,
localTime?: string | null,
dateTime?: string | null,
approximate?: boolean | null,
noSpecificTime?: boolean | null
} | null,
timezone?: string | null,
spanMultipleDays?: boolean | null,
status?: {
code?: string | null
} | null
} | null,
sales?: {
public?: {
startDateTime?: string | null,
endDateTime?: string | null,
startTBD?: boolean | null,
startTBA?: boolean | null
} | null,
presales?: {
name?: string | null,
description?: string | null,
url?: string | null,
startDateTime?: string | null,
endDateTime?: string | null,
startTBD?: boolean | null,
startTBA?: boolean | null
}[] | null
} | null,
priceRanges?: {
type?: string | null,
currency?: string | null,
min?: number | null,
max?: number | null
}[] | null,
classifications?: {
primary?: boolean | null,
family?: boolean | null,
segment?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null,
_embedded?: {
genres?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null,
_embedded?: {
subgenres?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
}[] | null
} | null
}[] | null
} | null
} | null,
genre?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null,
_embedded?: {
subgenres?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
}[] | null
} | null
} | null,
subGenre?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
} | null,
type?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
} | null,
subType?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
} | null
}[] | null,
promoter?: {
id?: string | null
} | null,
promoters?: {
id?: string | null
}[] | null,
outlets?: {
href?: string | null,
templated?: boolean | null
}[] | null,
products?: {
href?: string | null,
templated?: boolean | null
}[] | null,
aliases?: string[] | null,
seatmap?: {
} | null,
accessibility?: {
} | null,
ticketLimit?: {
} | null,
place?: {
} | null,
externalLinks?: {
} | null,
localizedAliases?: {
} | null,
_embedded?: {
venues?: {
id: string,
name?: string | null,
type?: string | null,
test?: boolean | null,
url?: string | null,
locale?: string | null,
description?: string | null,
additionalInfo?: string | null,
postalCode?: string | null,
timezone?: string | null,
currency?: string | null,
city?: {
name?: string | null
} | null,
state?: {
name?: string | null,
stateCode?: string | null
} | null,
country?: {
name?: string | null,
countryCode?: string | null
} | null,
address?: {
line1?: string | null
} | null,
location?: {
longitude?: string | number | null,
latitude?: string | number | null
} | null,
markets?: {
id?: string | number | null
}[] | null,
dmas?: {
id?: number | null
}[] | null,
images?: {
url?: string | null,
ratio?: string | null,
width?: number | null,
height?: number | null,
fallback?: boolean | null
}[] | null,
boxOfficeInfo?: {
} | null,
generalInfo?: {
} | null,
social?: {
} | null,
parkingDetail?: string | null,
accessibleSeatingDetail?: string | null,
upcomingEvents?: {
} | null,
_links?: {
} | null
}[] | null,
attractions?: {
id: string,
name?: string | null,
type?: string | null,
test?: boolean | null,
url?: string | null,
locale?: string | null,
description?: string | null,
additionalInfo?: string | null,
images?: {
url?: string | null,
ratio?: string | null,
width?: number | null,
height?: number | null,
fallback?: boolean | null
}[] | null,
classifications?: {
primary?: boolean | null,
family?: boolean | null,
segment?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null,
_embedded?: {
genres?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null,
_embedded?: {
subgenres?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
}[] | null
} | null
}[] | null
} | null
} | null,
genre?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null,
_embedded?: {
subgenres?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
}[] | null
} | null
} | null,
subGenre?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
} | null,
type?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
} | null,
subType?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
} | null
}[] | null,
aliases?: string[] | null,
localizedAliases?: {
} | null,
externalLinks?: {
} | null,
upcomingEvents?: {
} | null,
_links?: {
} | null
}[] | null
} | null,
_links?: {
} | null
}[]
page full type
page full type
{
size?: number | null,
totalElements?: number | null,
totalPages?: number | null,
number?: number | null
}
Suggest
get
suggest.get
Suggest attractions, events, venues and products for a partial search term, as a type-ahead would
Risk: read
await corsair.ticketmaster.api.suggest.get({ keyword: 'coachella', size: 3 });
| Name | Type | Required | Description |
|---|---|---|---|
keyword | string | No | What the user has typed so far. |
latlong | string | No | — |
geoPoint | string | No | — |
radius | number | No | — |
unit | 'miles' | 'km' | No | — |
source | string | No | — |
locale | string | No | ISO locale, such as ‘en-us’. Comma-separated values are allowed; ’*’ may end the list. |
countryCode | string | No | — |
segmentId | string[] | No | — |
resource | ('attractions' | 'events' | 'venues' | 'products')[] | No | Which collections to suggest from. Ticketmaster defaults to all four. |
includeTBA | 'yes' | 'no' | 'only' | No | — |
includeTBD | 'yes' | 'no' | 'only' | No | — |
includeTest | 'yes' | 'no' | 'only' | No | — |
includeSpellcheck | 'yes' | 'no' | No | — |
startEndDateTime | string | No | — |
localStartEndDateTime | string | No | — |
preferredCountry | 'us' | 'ca' | No | — |
size | number | No | Items per collection. Ticketmaster defaults to 5. |
domain | string[] | No | Only entities available on these domains, such as ticketmaster.com. |
| Name | Type | Required | Description |
|---|---|---|---|
attractions | object[] | Yes | — |
events | object[] | Yes | — |
venues | object[] | Yes | — |
products | object[] | Yes | — |
attractions full type
attractions full type
{
id: string,
name?: string | null,
type?: string | null,
test?: boolean | null,
url?: string | null,
locale?: string | null,
description?: string | null,
additionalInfo?: string | null,
images?: {
url?: string | null,
ratio?: string | null,
width?: number | null,
height?: number | null,
fallback?: boolean | null
}[] | null,
classifications?: {
primary?: boolean | null,
family?: boolean | null,
segment?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null,
_embedded?: {
genres?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null,
_embedded?: {
subgenres?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
}[] | null
} | null
}[] | null
} | null
} | null,
genre?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null,
_embedded?: {
subgenres?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
}[] | null
} | null
} | null,
subGenre?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
} | null,
type?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
} | null,
subType?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
} | null
}[] | null,
aliases?: string[] | null,
localizedAliases?: {
} | null,
externalLinks?: {
} | null,
upcomingEvents?: {
} | null,
_links?: {
} | null
}[]
events full type
events full type
{
id: string,
name?: string | null,
type?: string | null,
test?: boolean | null,
url?: string | null,
locale?: string | null,
description?: string | null,
additionalInfo?: string | null,
info?: string | null,
pleaseNote?: string | null,
productType?: string | null,
images?: {
url?: string | null,
ratio?: string | null,
width?: number | null,
height?: number | null,
fallback?: boolean | null
}[] | null,
dates?: {
start?: {
localDate?: string | null,
localTime?: string | null,
dateTime?: string | null,
dateTBD?: boolean | null,
dateTBA?: boolean | null,
timeTBA?: boolean | null,
noSpecificTime?: boolean | null
} | null,
end?: {
localDate?: string | null,
localTime?: string | null,
dateTime?: string | null,
approximate?: boolean | null,
noSpecificTime?: boolean | null
} | null,
timezone?: string | null,
spanMultipleDays?: boolean | null,
status?: {
code?: string | null
} | null
} | null,
sales?: {
public?: {
startDateTime?: string | null,
endDateTime?: string | null,
startTBD?: boolean | null,
startTBA?: boolean | null
} | null,
presales?: {
name?: string | null,
description?: string | null,
url?: string | null,
startDateTime?: string | null,
endDateTime?: string | null,
startTBD?: boolean | null,
startTBA?: boolean | null
}[] | null
} | null,
priceRanges?: {
type?: string | null,
currency?: string | null,
min?: number | null,
max?: number | null
}[] | null,
classifications?: {
primary?: boolean | null,
family?: boolean | null,
segment?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null,
_embedded?: {
genres?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null,
_embedded?: {
subgenres?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
}[] | null
} | null
}[] | null
} | null
} | null,
genre?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null,
_embedded?: {
subgenres?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
}[] | null
} | null
} | null,
subGenre?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
} | null,
type?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
} | null,
subType?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
} | null
}[] | null,
promoter?: {
id?: string | null
} | null,
promoters?: {
id?: string | null
}[] | null,
outlets?: {
href?: string | null,
templated?: boolean | null
}[] | null,
products?: {
href?: string | null,
templated?: boolean | null
}[] | null,
aliases?: string[] | null,
seatmap?: {
} | null,
accessibility?: {
} | null,
ticketLimit?: {
} | null,
place?: {
} | null,
externalLinks?: {
} | null,
localizedAliases?: {
} | null,
_embedded?: {
venues?: {
id: string,
name?: string | null,
type?: string | null,
test?: boolean | null,
url?: string | null,
locale?: string | null,
description?: string | null,
additionalInfo?: string | null,
postalCode?: string | null,
timezone?: string | null,
currency?: string | null,
city?: {
name?: string | null
} | null,
state?: {
name?: string | null,
stateCode?: string | null
} | null,
country?: {
name?: string | null,
countryCode?: string | null
} | null,
address?: {
line1?: string | null
} | null,
location?: {
longitude?: string | number | null,
latitude?: string | number | null
} | null,
markets?: {
id?: string | number | null
}[] | null,
dmas?: {
id?: number | null
}[] | null,
images?: {
url?: string | null,
ratio?: string | null,
width?: number | null,
height?: number | null,
fallback?: boolean | null
}[] | null,
boxOfficeInfo?: {
} | null,
generalInfo?: {
} | null,
social?: {
} | null,
parkingDetail?: string | null,
accessibleSeatingDetail?: string | null,
upcomingEvents?: {
} | null,
_links?: {
} | null
}[] | null,
attractions?: {
id: string,
name?: string | null,
type?: string | null,
test?: boolean | null,
url?: string | null,
locale?: string | null,
description?: string | null,
additionalInfo?: string | null,
images?: {
url?: string | null,
ratio?: string | null,
width?: number | null,
height?: number | null,
fallback?: boolean | null
}[] | null,
classifications?: {
primary?: boolean | null,
family?: boolean | null,
segment?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null,
_embedded?: {
genres?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null,
_embedded?: {
subgenres?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
}[] | null
} | null
}[] | null
} | null
} | null,
genre?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null,
_embedded?: {
subgenres?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
}[] | null
} | null
} | null,
subGenre?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
} | null,
type?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
} | null,
subType?: {
id?: string | null,
name?: string | null,
locale?: string | null,
href?: string | null,
templated?: boolean | null,
_links?: {
} | null
} | null
}[] | null,
aliases?: string[] | null,
localizedAliases?: {
} | null,
externalLinks?: {
} | null,
upcomingEvents?: {
} | null,
_links?: {
} | null
}[] | null
} | null,
_links?: {
} | null
}[]
venues full type
venues full type
{
id: string,
name?: string | null,
type?: string | null,
test?: boolean | null,
url?: string | null,
locale?: string | null,
description?: string | null,
additionalInfo?: string | null,
postalCode?: string | null,
timezone?: string | null,
currency?: string | null,
city?: {
name?: string | null
} | null,
state?: {
name?: string | null,
stateCode?: string | null
} | null,
country?: {
name?: string | null,
countryCode?: string | null
} | null,
address?: {
line1?: string | null
} | null,
location?: {
longitude?: string | number | null,
latitude?: string | number | null
} | null,
markets?: {
id?: string | number | null
}[] | null,
dmas?: {
id?: number | null
}[] | null,
images?: {
url?: string | null,
ratio?: string | null,
width?: number | null,
height?: number | null,
fallback?: boolean | null
}[] | null,
boxOfficeInfo?: {
} | null,
generalInfo?: {
} | null,
social?: {
} | null,
parkingDetail?: string | null,
accessibleSeatingDetail?: string | null,
upcomingEvents?: {
} | null,
_links?: {
} | null
}[]
products full type
products full type
{
}[]
Venues
get
venues.get
Get one venue by ID, including its address, location, timezone, markets and images
Risk: read
await corsair.ticketmaster.api.venues.get({ id: 'KovZpZA7AAEA' });
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The venue ID. |
locale | string | No | ISO locale, such as ‘en-us’. Comma-separated values are allowed; ’*’ may end the list. |
domain | string[] | No | Only entities available on these domains, such as ticketmaster.com. |
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
name | string | null | No | — |
type | string | null | No | — |
test | boolean | null | No | — |
url | string | null | No | — |
locale | string | null | No | — |
description | string | null | No | — |
additionalInfo | string | null | No | — |
postalCode | string | null | No | — |
timezone | string | null | No | — |
currency | string | null | No | — |
city | object | null | No | — |
state | object | null | No | — |
country | object | null | No | — |
address | object | null | No | — |
location | object | null | No | — |
markets | object[] | null | No | — |
dmas | object[] | null | No | — |
images | object[] | null | No | — |
boxOfficeInfo | object | null | No | — |
generalInfo | object | null | No | — |
social | object | null | No | — |
parkingDetail | string | null | No | — |
accessibleSeatingDetail | string | null | No | — |
upcomingEvents | object | null | No | — |
_links | object | null | No | — |
city full type
city full type
{
name?: string | null
}
state full type
state full type
{
name?: string | null,
stateCode?: string | null
}
country full type
country full type
{
name?: string | null,
countryCode?: string | null
}
address full type
address full type
{
line1?: string | null
}
location full type
location full type
{
longitude?: string | number | null,
latitude?: string | number | null
}
markets full type
markets full type
{
id?: string | number | null
}[]
dmas full type
dmas full type
{
id?: number | null
}[]
images full type
images full type
{
url?: string | null,
ratio?: string | null,
width?: number | null,
height?: number | null,
fallback?: boolean | null
}[]
boxOfficeInfo full type
boxOfficeInfo full type
Record<string, unknown>
generalInfo full type
generalInfo full type
Record<string, unknown>
social full type
social full type
upcomingEvents full type
upcomingEvents full type
Record<string, unknown>
_links full type
_links full type
Record<string, unknown>
search
venues.search
Search venues by keyword, country, state or geo point, with paging and sorting
Risk: read
await corsair.ticketmaster.api.venues.search({ keyword: 'Madison Square Garden', countryCode: 'US', size: 5 });
| Name | Type | Required | Description |
|---|---|---|---|
id | string | No | — |
keyword | string | No | — |
latlong | string | No | ’latitude,longitude’. Deprecated by Ticketmaster in favour of geoPoint. |
geoPoint | string | No | — |
radius | number | No | — |
unit | 'miles' | 'km' | No | — |
source | string | No | Publishing source, such as ‘ticketmaster’, ‘universe’, ‘frontgate’ or ‘tmr’. |
locale | string | No | ISO locale, such as ‘en-us’. Comma-separated values are allowed; ’*’ may end the list. |
includeTest | 'yes' | 'no' | 'only' | No | — |
includeSpellcheck | 'yes' | 'no' | No | — |
countryCode | string | No | — |
stateCode | string | No | — |
sort | string | No | Field and direction, such as ‘name,asc’ or ‘distance,asc’. Ticketmaster defaults to relevance,desc. |
preferredCountry | 'us' | 'ca' | No | — |
size | number | No | Items per page. Ticketmaster defaults to 20. |
page | number | No | 0-based page number. |
domain | string[] | No | Only entities available on these domains, such as ticketmaster.com. |
| Name | Type | Required | Description |
|---|---|---|---|
venues | object[] | Yes | — |
page | object | null | No | — |
next_page | number | null | No | The next 0-based page, or null on the last one. Ticketmaster stops at the 1000th item, so this is also null once that limit is reached. |
venues full type
venues full type
{
id: string,
name?: string | null,
type?: string | null,
test?: boolean | null,
url?: string | null,
locale?: string | null,
description?: string | null,
additionalInfo?: string | null,
postalCode?: string | null,
timezone?: string | null,
currency?: string | null,
city?: {
name?: string | null
} | null,
state?: {
name?: string | null,
stateCode?: string | null
} | null,
country?: {
name?: string | null,
countryCode?: string | null
} | null,
address?: {
line1?: string | null
} | null,
location?: {
longitude?: string | number | null,
latitude?: string | number | null
} | null,
markets?: {
id?: string | number | null
}[] | null,
dmas?: {
id?: number | null
}[] | null,
images?: {
url?: string | null,
ratio?: string | null,
width?: number | null,
height?: number | null,
fallback?: boolean | null
}[] | null,
boxOfficeInfo?: {
} | null,
generalInfo?: {
} | null,
social?: {
} | null,
parkingDetail?: string | null,
accessibleSeatingDetail?: string | null,
upcomingEvents?: {
} | null,
_links?: {
} | null
}[]
page full type
page full type
{
size?: number | null,
totalElements?: number | null,
totalPages?: number | null,
number?: number | null
}