Skip to main content
logo
Documentation Powered by ReDoc

viagogo Catalog API (1.0.0.75)

Categories

View categories on the viagogo platform

Search categories

Get matching category given the query string.

Authorizations:
OAuth2 (read:categories)
query Parameters
q
string or null

The query text to be used to match categories.

Responses

Response Schema: application/octet-stream
string <binary>

Response samples

Content type
application/hal+json
{
  • "code": "string",
  • "message": "string",
  • "errors": {
    }
}

Events

View events on the viagogo platform

List events

Lists all events on the viagogo platform. Use this endpoint to sync the entire viagogo event catalog with your application.

Authorizations:
OAuth2 (read:events)
query Parameters
page
integer <int32>

Specifies which page of data to retrieve.

page_size
integer <int32>

Set custom page sizes on response.

updated_since
string <date-time>

Filters the response to only return items that have been updated since the given timestamp

sort
string

Determines the ordering of items. A comma-separated string containing resource_version.

min_resource_version
integer or null <int64>
country_code
string

Filters results to only include events located in the specified country.

latitude
number or null <double>

When provided with longitude and distance filters events returned to ones within the specified distance of the lat/long.

longitude
number or null <double>

When provided with latitude and distance filters events returned to ones within the specified distance of the lat/long.

max_distance_in_meters
integer or null <int32>

When provided with latitude and longitude filters events returned to ones within the specified distance of the lat/long.

genre_id
integer or null <int32>

Filters results to only include events for the specified genre id.

exclude_parking_passes
boolean or null

Filters results to remove parking passes

Responses

Response Schema: application/hal+json
total_items
integer or null <int32>
page
integer or null <int32>
page_size
integer or null <int32>
(EventsLinks (object or null))
(EventsEmbeddedResources (object or null))

Response samples

Content type
application/hal+json
{
  • "total_items": 0,
  • "page": 0,
  • "page_size": 0,
  • "_links": {
    },
  • "_embedded": {
    }
}

List events by event ids.

List a specified set of events on the viagogo platform. Note that the eventID being passed can already be merged with another event. And in this case, details of the new event will be returned, if a different eventId is returned then it means that the event has been merged with the returned event. Also inside _embedded field of the response, a mapping between the original eventId and new eventId will be provided.

Authorizations:
OAuth2 (read:events)
query Parameters
page
integer <int32>

Specifies which page of data to retrieve.

page_size
integer <int32>

Set custom page sizes on response.

updated_since
string <date-time>

Filters the response to only return items that have been updated since the given timestamp

sort
string

Determines the ordering of items. A comma-separated string containing resource_version.

min_resource_version
integer or null <int64>
country_code
string

Filters results to only include events located in the specified country.

latitude
number or null <double>

When provided with longitude and distance filters events returned to ones within the specified distance of the lat/long.

longitude
number or null <double>

When provided with latitude and distance filters events returned to ones within the specified distance of the lat/long.

max_distance_in_meters
integer or null <int32>

When provided with latitude and longitude filters events returned to ones within the specified distance of the lat/long.

genre_id
integer or null <int32>

Filters results to only include events for the specified genre id.

exclude_parking_passes
boolean or null

Filters results to remove parking passes

Request Body schema: application/json
event_ids
Array of integers <int32>

The viagogo event identifiers of the events to be retrieved.

Responses

Response Schema: application/hal+json
total_items
integer or null <int32>
page
integer or null <int32>
page_size
integer or null <int32>
(EventsLinks (object or null))
(EventsEmbeddedResources (object or null))

Request samples

Content type
application/json
{
  • "event_ids": [
    ]
}

Response samples

Content type
application/hal+json
{
  • "total_items": 0,
  • "page": 0,
  • "page_size": 0,
  • "_links": {
    },
  • "_embedded": {
    }
}

List events by category id.

List set of events filtered by category id on the viagogo platform.

Authorizations:
OAuth2 (read:events)
path Parameters
categoryId
required
integer <int32>
query Parameters
page
integer <int32>

Specifies which page of data to retrieve.

page_size
integer <int32>

Set custom page sizes on response.

updated_since
string <date-time>

Filters the response to only return items that have been updated since the given timestamp

sort
string

Determines the ordering of items. A comma-separated string containing resource_version.

min_resource_version
integer or null <int64>
country_code
string

Filters results to only include events located in the specified country.

latitude
number or null <double>

When provided with longitude and distance filters events returned to ones within the specified distance of the lat/long.

longitude
number or null <double>

When provided with latitude and distance filters events returned to ones within the specified distance of the lat/long.

max_distance_in_meters
integer or null <int32>

When provided with latitude and longitude filters events returned to ones within the specified distance of the lat/long.

genre_id
integer or null <int32>

Filters results to only include events for the specified genre id.

exclude_parking_passes
boolean or null

Filters results to remove parking passes

Responses

Response Schema: application/hal+json
total_items
integer or null <int32>
page
integer or null <int32>
page_size
integer or null <int32>
(EventsLinks (object or null))
(EventsEmbeddedResources (object or null))

Response samples

Content type
application/hal+json
{
  • "total_items": 0,
  • "page": 0,
  • "page_size": 0,
  • "_links": {
    },
  • "_embedded": {
    }
}

Get an event on the viagogo platform using an identifier from an external platform.

Authorizations:
OAuth2 (read:events)
path Parameters
platform
required
string or null

The name of the external platform. Can be legacy_stubhub

externalEventId
required
integer <int32>

The event identifier from the external platform.

Responses

Response Schema: application/hal+json
id
integer <int32>

The event identifier.

name
string

The name of the event.

start_date
string <date-time>

The date when the event starts.

end_date
string or null <date-time>

The date when the event ends.

on_sale_date
string or null <date-time>

The date when tickets for the event will go onsale.

date_confirmed
boolean

True if the event start and end date have been confirmed; Otherwise, false.

time_confirmed
boolean

True if the event start and end time have been confirmed; Otherwise, false.

type
string

The type of the event. Can be Main or Parking

Money (object)

The minimum ticket price of the event.

status
string

The status of the event. Can be Normal, Postponed, Cancelled, Rescheduled, Relocated, RelocatedAndRescheduled, Draft, Contingent and Deleted

(EventLinks (object or null))
(EventEmbeddedResources (object or null))

Response samples

Content type
application/hal+json
{
  • "id": 0,
  • "name": "string",
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "on_sale_date": "2019-08-24T14:15:22Z",
  • "date_confirmed": true,
  • "time_confirmed": true,
  • "type": "string",
  • "min_ticket_price": {
    },
  • "status": "string",
  • "_links": {
    },
  • "_embedded": {
    }
}

Get an event

Note that the eventID being passed can already be merged with another event. And in this case, details of the new event will be returned, if a different eventId is returned then it means that the event has been merged with the returned event. Also inside _embedded field of the response, a mapping between the original eventId and new eventId will be provided.

Authorizations:
OAuth2 (read:events)
path Parameters
eventId
required
integer <int32>

The event identifier

Responses

Response Schema: application/hal+json
id
integer <int32>

The event identifier.

name
string

The name of the event.

start_date
string <date-time>

The date when the event starts.

end_date
string or null <date-time>

The date when the event ends.

on_sale_date
string or null <date-time>

The date when tickets for the event will go onsale.

date_confirmed
boolean

True if the event start and end date have been confirmed; Otherwise, false.

time_confirmed
boolean

True if the event start and end time have been confirmed; Otherwise, false.

type
string

The type of the event. Can be Main or Parking

Money (object)

The minimum ticket price of the event.

status
string

The status of the event. Can be Normal, Postponed, Cancelled, Rescheduled, Relocated, RelocatedAndRescheduled, Draft, Contingent and Deleted

(EventLinks (object or null))
(EventEmbeddedResources (object or null))

Response samples

Content type
application/hal+json
{
  • "id": 0,
  • "name": "string",
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "on_sale_date": "2019-08-24T14:15:22Z",
  • "date_confirmed": true,
  • "time_confirmed": true,
  • "type": "string",
  • "min_ticket_price": {
    },
  • "status": "string",
  • "_links": {
    },
  • "_embedded": {
    }
}

Search events

Search for events on the viagogo platform. Use this endpoint to search the entire viagogo event catalog with your application.

Authorizations:
OAuth2 (read:events)
query Parameters
q
string or null

The query text to be used to match events.

dateLocal
string or null <date-time>

The specific date of the event, this is optional

page
integer <int32>

Specifies which page of data to retrieve.

page_size
integer <int32>

Set custom page sizes on response.

updated_since
string <date-time>

Filters the response to only return items that have been updated since the given timestamp

sort
string

Determines the ordering of items. A comma-separated string containing resource_version.

min_resource_version
integer or null <int64>
country_code
string

Filters results to only include events located in the specified country.

latitude
number or null <double>

When provided with longitude and distance filters events returned to ones within the specified distance of the lat/long.

longitude
number or null <double>

When provided with latitude and distance filters events returned to ones within the specified distance of the lat/long.

max_distance_in_meters
integer or null <int32>

When provided with latitude and longitude filters events returned to ones within the specified distance of the lat/long.

genre_id
integer or null <int32>

Filters results to only include events for the specified genre id.

exclude_parking_passes
boolean or null

Filters results to remove parking passes

Responses

Response Schema: application/hal+json
total_items
integer or null <int32>
page
integer or null <int32>
page_size
integer or null <int32>
(EventsLinks (object or null))
(EventsEmbeddedResources (object or null))

Response samples

Content type
application/hal+json
{
  • "total_items": 0,
  • "page": 0,
  • "page_size": 0,
  • "_links": {
    },
  • "_embedded": {
    }
}

Get all events under a CategoryId

Finds all CategoryIds under the parents, and finds all events under all of them- de-duped by storing in a HashSet.

Authorizations:
OAuth2 (read:events)
path Parameters
categoryId
required
integer <int32>

CategoryId for which we want all events

query Parameters
page
integer <int32>

Specifies which page of data to retrieve.

page_size
integer <int32>

Set custom page sizes on response.

updated_since
string <date-time>

Filters the response to only return items that have been updated since the given timestamp

sort
string

Determines the ordering of items. A comma-separated string containing resource_version.

min_resource_version
integer or null <int64>
country_code
string

Filters results to only include events located in the specified country.

latitude
number or null <double>

When provided with longitude and distance filters events returned to ones within the specified distance of the lat/long.

longitude
number or null <double>

When provided with latitude and distance filters events returned to ones within the specified distance of the lat/long.

max_distance_in_meters
integer or null <int32>

When provided with latitude and longitude filters events returned to ones within the specified distance of the lat/long.

genre_id
integer or null <int32>

Filters results to only include events for the specified genre id.

exclude_parking_passes
boolean or null

Filters results to remove parking passes

Responses

Response Schema: application/hal+json
total_items
integer or null <int32>
page
integer or null <int32>
page_size
integer or null <int32>
(EventsLinks (object or null))
(EventsEmbeddedResources (object or null))

Response samples

Content type
application/hal+json
{
  • "total_items": 0,
  • "page": 0,
  • "page_size": 0,
  • "_links": {
    },
  • "_embedded": {
    }
}

Map request to StubHub Event, Venue and Category

Finds mapped Event, Venue and Category information, if available.

Authorizations:
OAuth2 (read:events)
Request Body schema: application/json

Request metadata for which we want all mapped information

event_name
string
local_date
string <date-time>
venue_name
string
venue_state
string
venue_city
string
venue_country
string
category_name
string or null

Responses

Response Schema: application/hal+json
(Event (object or null))
(Venue (object or null))
(Category (object or null))

Request samples

Content type
application/json
{
  • "event_name": "string",
  • "local_date": "2019-08-24T14:15:22Z",
  • "venue_name": "string",
  • "venue_state": "string",
  • "venue_city": "string",
  • "venue_country": "string",
  • "category_name": "string"
}

Response samples

Content type
application/hal+json
{
  • "EventResource": {
    },
  • "VenueResource": {
    },
  • "CategoryResource": {
    }
}

Venues

View venues on the viagogo platform

List venues

Lists all venues on the viagogo platform. Use this endpoint to sync the entire viagogo Venue catalog with your application.

Authorizations:
OAuth2 (read:venues)
query Parameters
page
integer <int32>

Specifies which page of data to retrieve.

page_size
integer <int32>

Set custom page sizes on response.

updated_since
string <date-time>

Filters the response to only return items that have been updated since the given timestamp

sort
string

Determines the ordering of items. A comma-separated string containing resource_version.

country_code
string

Filters results to only include venues located in the specified country.

Responses

Response Schema: application/hal+json
total_items
integer or null <int32>
page
integer or null <int32>
page_size
integer or null <int32>
(VenuesLinks (object or null))
(VenuesEmbeddedResources (object or null))

Response samples

Content type
application/hal+json
{
  • "total_items": 0,
  • "page": 0,
  • "page_size": 0,
  • "_links": {
    },
  • "_embedded": {
    }
}

Get a venue

Authorizations:
OAuth2 (read:venues)
path Parameters
venueId
required
integer <int32>

The venue identifier

Responses

Response Schema: application/hal+json
id
integer <int32>

The venue identifier.

name
string

The name of the venue.

city
string

The name of the city where the venue is located.

state_province
string

The name of the State or Province where the venue is located.

postal_code
string

The postal code for the venue.

latitude
number or null <double>

The latitude for the venue.

longitude
number or null <double>

The longitude for the venue.

(VenueLinks (object or null))
(VenueEmbeddedResources (object or null))

Response samples

Content type
application/hal+json
{
  • "id": 0,
  • "name": "string",
  • "city": "string",
  • "state_province": "string",
  • "postal_code": "string",
  • "latitude": 0,
  • "longitude": 0,
  • "_links": {
    },
  • "_embedded": {
    }
}

Money

Returned for monetary values, such as ticket prices, fees charged and tax amounts.

amount
number or null <decimal>

The decimal amount of the money.

currency_code
string

The ISO 4217 currency code that the monetary value is represented in.

display
string

A user-friendly string representing the monetary value.

{
  • "amount": 0,
  • "currency_code": "string",
  • "display": "string"
}

Event

An event on the viagogo platform.

id
integer <int32>

The event identifier.

name
string

The name of the event.

start_date
string <date-time>

The date when the event starts.

end_date
string or null <date-time>

The date when the event ends.

on_sale_date
string or null <date-time>

The date when tickets for the event will go onsale.

date_confirmed
boolean

True if the event start and end date have been confirmed; Otherwise, false.

time_confirmed
boolean

True if the event start and end time have been confirmed; Otherwise, false.

type
string

The type of the event. Can be Main or Parking

Money (object)

The minimum ticket price of the event.

status
string

The status of the event. Can be Normal, Postponed, Cancelled, Rescheduled, Relocated, RelocatedAndRescheduled, Draft, Contingent and Deleted

(EventLinks (object or null))
(EventEmbeddedResources (object or null))
{
  • "id": 0,
  • "name": "string",
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "on_sale_date": "2019-08-24T14:15:22Z",
  • "date_confirmed": true,
  • "time_confirmed": true,
  • "type": "string",
  • "min_ticket_price": {
    },
  • "status": "string",
  • "_links": {
    },
  • "_embedded": {
    }
}

Events

total_items
integer or null <int32>
page
integer or null <int32>
page_size
integer or null <int32>
(EventsLinks (object or null))
(EventsEmbeddedResources (object or null))
{
  • "total_items": 0,
  • "page": 0,
  • "page_size": 0,
  • "_links": {
    },
  • "_embedded": {
    }
}

MapEventResponseModel

(Event (object or null))
(Venue (object or null))
(Category (object or null))
{
  • "EventResource": {
    },
  • "VenueResource": {
    },
  • "CategoryResource": {
    }
}

Venue

An venue on the viagogo platform.

id
integer <int32>

The venue identifier.

name
string

The name of the venue.

city
string

The name of the city where the venue is located.

state_province
string

The name of the State or Province where the venue is located.

postal_code
string

The postal code for the venue.

latitude
number or null <double>

The latitude for the venue.

longitude
number or null <double>

The longitude for the venue.

(VenueLinks (object or null))
(VenueEmbeddedResources (object or null))
{
  • "id": 0,
  • "name": "string",
  • "city": "string",
  • "state_province": "string",
  • "postal_code": "string",
  • "latitude": 0,
  • "longitude": 0,
  • "_links": {
    },
  • "_embedded": {
    }
}

Venues

total_items
integer or null <int32>
page
integer or null <int32>
page_size
integer or null <int32>
(VenuesLinks (object or null))
(VenuesEmbeddedResources (object or null))
{
  • "total_items": 0,
  • "page": 0,
  • "page_size": 0,
  • "_links": {
    },
  • "_embedded": {
    }
}