...
...
Long Description
Possible Event States
The possible event states are shown
, postponed
, and canceled
.
TBD Events
TBD Events will be returned with an occurs_at
of 00:00:00
.
...
Note |
---|
Note: You should not use the list method with a name parameter to search events as that will perform an exact match search. To search events first use the /search endpoint to search against your string and then list events using a performer_id or venue_id selected from your /search results. |
...
...
The seating_chart image URLs within the configuration object are deprecated and no longer updated. Instead, you should use our dynamic seating charts. |
Parameters
Name | Description | Type | Presence | Location | Conditionals |
---|
venue_id
| Venue at which the event occurs | Integer | Optional | Query | No |
name
| Exact name of the event. Use Events / Search when searching for events by name. | String | Optional | Query | No |
occurs_at
| Refine dates at which the event occurs using an ISO 8601 formatted datetime. Info |
---|
You can use occurs_at twice when using conditionals to retrieve events within a date range. For example, to retrieve only events within April 2018 use occurs_at.gte=2018-04-01& occurs_at.lt=2018-05-01 |
| Date (ISO_8601) | Optional | Query | Yes |
updated_at
| Refine dates at which the event was updated using an ISO 8601 formatted datetime | Date (ISO_8601) | Optional | Query | Yes |
popularity_score
| Refine long term popularity score | Decimal | Optional | Query | No |
short_term_popularity_score
| Refine short term popularity score | Decimal | Optional | Query | No |
office_id
| Show only events for which this office has tickets | Integer | Optional | Query | No |
performer_id
| Show only events at which this performer will perform | Integer | Optional | Query | No |
primary_performer
| If primary_performer is true only events where performer_id is the Primary performer for the event will be returned. If primary_performer is false only events where performer_id is the NOT the Primary performer for the event will be returned. | Boolean | Optional | Query | No |
category_id
| Show only events in this category (does not include sub-categories) | Integer | Optional | Query | No |
category_tree
| When true and used in conjunction with category_id events in sub-categories of the category_id will be included. | Boolean | Optional | Query | No |
q
| Full-text search events | String | Optional | Query | No |
fuzzy
| When true and used in conjunction with |
q will q will result in fuzzy full text search. Will NOT work if passed |
without qwithout q. | Boolean | Option | Query | No |
lat
| Latitude & longitude for geolocated searches. Control size of geolocation area using within . Must supply both. | Decimal | Optional | Query | No |
lon
|
within
| Radius in miles for geolocated searches (default 15) | Decimal | Optional | Query | No |
ip
| Infer lat and lon by location of IP address for geolocated searches. | String | Optional | Query | No |
postal_code
| Infer lat and lon by location of postal code for geolocated searches. Control size of geolocation area using within . This method of geolocation is not recommended. | String | Optional | Query | No |
city_state
| Infer lat and lon by location of city and state for geolocated searches. Control size of geolocation area using within . This method of geolocation is not recommended. | String | Optional | Query | No |
within | Radius in miles for geolocated searches (default 15) | Decimalcountry_code
| Provide an ISO 3166 Alpha-2 country code to have results filtered to that specific country. | String (2) | Optional | Query | No |
only_with_tickets
| Show only events that have inventory |
irregardless ay
regardless of whether they are available for sale (All states will be shown). If you want only available tickets, use only_with_available_tickets | String [all | etickets ] | Optional | Query | No |
by_time
| Show only events whose start time is during the day (between 4 AM-4 PM) or night (otherwise) | String [ |
dOptional day | night ]
| Optional | Query | No |
only_with_available_tickets
| Show only events that have available tickets (tickets for sale). Pass with office_id for inventory belonging only to your office. | Boolean | Optional | Query | No |
order_by
| Pass in the parameter that you want to order by and the sorting order (Ex. :order_by => "events.popularity_score DESC") | String | Optional | Query | No |
min_and_max_price
| Results will include avg_price , sum_price , median_price , min_price & max_price , calculated based on that Credential’s settings | Boolean | Optional | Query | No |
only_discounted
|
Boolean | If true then only events that have discounted tickets will be returned. | Boolean | Optional | Query | No |
Examples
Request | Response |
---|
GET /v9/events? |
citystate=jersey%20city,nj&within=2id=13910&occurs_at.gte=2023-08-19&occurs_at.lte=2023-08-21 | |
theme | Confluence "current_page": 1,
"per_page": |
|
"events[{productseticket_0"updated_at"2013-02-19T22:29:13Zproducts_count":18Minor League Baseball",
"slug": " |
|
owned_by_office":falselong_term_popularity_score":0.44967 venue{
"/categories/minor-league",
|
|
url"/venues/6262",
name"Liberty National Golf Club id:6262 locationJerseyCity,NJ" },"url": "/categories/2",
" |
|
configuration{ fanvenues_keynull,ticket_utils_idnullurl/configurations/13110nameGeneral Admissionid13110seatingchart{ medium":"https://s3.amazonaws.com/media.ticketevolution.com/configurations/default_maps/ga_500.jpg",
large:"https//s3.amazonaws.com/media.ticketevolution.com/configurations/default_maps/ga_1000.jpg"
} },
"url": "/configurations/11583",
" |
|
popularity_score0 category{ url"/categories/131",
id"131", parent{
url/categories/24,"id":"24" "parent":{"long_term_popularity_score": 0.216,
"name": "Louisville Bats at Iowa Cubs",
" |
|
url/categories/1",
"occurs_at_local": "2023-08-19T00:00:00-05:00",
|
|
"id"1 "owned_by_office": false,
|
|
parentnull,name"Sports" },
nameGolf"
}name"PGA"
},
"state":"shown",
"url":"/events/376250",
"name":"2013 Barclays Golf",
"notes":null,
"occurs_at":"2013-08-23T08:00:00Z",
"id":376250,
"performances":[
{
"performer":{
"url":"/performers/25395",
"name":"The Barclays Golf",
"id":25395
},
"primary":true
}
]
},
{
"products_eticket_count":0,
"updated_at":"2013-02-19T22:29:13Z",
"products_count":33,
"owned_by_office":false,
"long_term_popularity_score":0.43603,
"venue":{
"url":"/venues/6262",
"name":"Liberty National Golf Club",
"id":6262,
"location":"Jersey City, NJ"
},
"configuration":{
"fanvenues_key":null,
"ticket_utils_id":null,
"url":"/configurations/13110",
"name":"General Admission",
"id":13110,
"seating_chart":{
"medium":"https://s3.amazonaws.com/media.ticketevolution.com/configurations/default_maps/ga_500.jpg",
"large":"https://s3.amazonaws.com/media.ticketevolution.com/configurations/default_maps/ga_1000.jpg"
}
},
"popularity_score":"0",
"category":{
"url":"/categories/131",
"id":"131",
"parent":{
"url":"/categories/24",
"id":"24",
"parent":{
"url":"/categories/1",
"id":"1",
"parent":null,
"name":"Sports"
},
"name":"Golf"
},
"name":"PGA"
},
"state":"shown",
"url":"/events/376251",
"name":"2013 Barclays Golf",
"notes":null,
"occurs_at":"2013-08-20T08:00:00Z",
"id":376251,
"performances":[
{
"performer":{
"url":"/performers/25395",
"name":"The Barclays Golf",
"id":25395
},
"primary":true
}
]
},
{
"products_eticket_count":0,
"updated_at":"2013-02-19T22:29:13Z",
"products_count":24,
"owned_by_office":false,
"long_term_popularity_score":0.4587,
"venue":{
"url":"/venues/6262",
"name":"Liberty National Golf Club",
"id":6262,
"location":"Jersey City, NJ"
},
"configuration":{
"fanvenues_key":null,
"ticket_utils_id":null,
"url":"/configurations/13110",
"name":"General Admission",
"id":13110,
"seating_chart":{
"medium":"https://s3.amazonaws.com/media.ticketevolution.com/configurations/default_maps/ga_500.jpg",
"large":"https://s3.amazonaws.com/media.ticketevolution.com/configurations/default_maps/ga_1000.jpg"
}
},
"popularity_score":"0",
"category":{
"url":"/categories/131",
"id":"131",
"parent":{
"url":"/categories/24",
"id":"24",
"parent":{
"url":"/categories/1",
"id":"1",
"parent":null,
"name":"Sports"
},
"name":"Golf"
},
"name":"PGA"
},
"state":"shown",
"url":"/events/376252",
"name":"2013 Barclays Golf",
"notes":null,
"occurs_at":"2013-08-24T08:00:00Z",
"id":376252,
"performances":[
{
"performer":{
"url":"/performers/25395",
"name":"The Barclays Golf",
"id":25395
},
"primary":true
}
]
},
{
"products_eticket_count":0,
"updated_at":"2013-02-19T22:29:13Z",
"products_count":24,
"owned_by_office":false,
"long_term_popularity_score":0.45029,
"venue":{
"url":"/venues/6262",
"name":"Liberty National Golf Club",
"id":6262,
"location":"Jersey City, NJ"
},
"configuration":{
"fanvenues_key":null,
"ticket_utils_id":null,
"url":"/configurations/13110",
"name":"General Admission",
"id":13110,
"seating_chart":{
"medium":"https://s3.amazonaws.com/media.ticketevolution.com/configurations/default_maps/ga_500.jpg",
"large":"https://s3.amazonaws.com/media.ticketevolution.com/configurations/default_maps/ga_1000.jpg"
}
},
"popularity_score":"0",
"category":{
"url":"/categories/131",
"id":"131",
"parent":{
"url":"/categories/24",
"id":"24",
"parent":{
"url":"/categories/1",
"id":"1",
"parent":null,
"name":"Sports"
},
"name":"Golf"
},
"name":"PGA"
},
"state":"shown",
"url":"/events/376253",
"name":"2013 Barclays Golf",
"notes":null,
"occurs_at":"2013-08-25T08:00:00Z",
"id":376253,
"performances":[
{
"performer":{
"url":"/performers/25395",
"name":"The Barclays Golf",
"id":25395
},
"primary":true
}
]
},
{
"products_eticket_count":0,
"updated_at":"2013-02-19T22:29:13Z",
"products_count":24,
"owned_by_office":false,
"long_term_popularity_score":0.45202,
"venue":{
"url":"/venues/6262",
"name":"Liberty National Golf Club",
"id":6262,
"location":"Jersey City, NJ"
},
"configuration":{
"fanvenues_key":null,
"ticket_utils_id":null,
"url":"/configurations/13110",
"name":"General Admission",
"id":13110,
"seating_chart":{
"medium":"https://s3.amazonaws.com/media.ticketevolution.com/configurations/default_maps/ga_500.jpg",
"large":"https://s3.amazonaws.com/media.ticketevolution.com/configurations/default_maps/ga_1000.jpg"
"/performers/louisville-bats",
|
|
} "url": "/performers/14029",
|
|
}, popularity_score"15.08", "category":{url"/categories/131","id":"131",parent url"/categories/24",
id24 "parent{
categories113910",
"name": "Iowa Cubs"
|
|
"id":"1",parentnull,"name":"Sports" "popularity_score": 2.78,
|
|
}"products_count": 811,
"products_eticket_count": 459,
|
|
nameGolf"Brennen Davis Bobblehead Giveaway",
|
|
},
name"PGA" },
"updated_at": "2023-07-25T14:41:34Z",
" |
|
stateshown
url"/events/376254",name"2013 Barclays Golf"notes:null
occurs_at"2013-08-22T08:00:00Z "/venues/4735",
"slug_url": " |
|
id":376254,
/venues/principal-park",
" |
|
performances[ "Principal Park",
"location": "Des |
|
{
performer{ "America/Chicago"
},
"discount_magnitude": 0
|
|
"url":"/performers/25395" },
{
"available_count": 897,
" |
|
name"The Barclays Golf",id25395 "Minor League Baseball",
"slug": "minor-league",
|
|
}, "url": "/categories/4",
" |
|
primarytrue "/categories/minor-league",
"parent": {
|
|
}]},{ products_eticket_count":0,updated_at"2013-02-19T22:29:13Zproductscount24 "/categories/baseball",
" |
|
owned_by_officefalse,long_term_popularity_score":0.42858,venue{url/venues/6262name"Liberty National Golf Clubid6262location"JerseyCity,NJ","configuration":{fanvenues_keynull, ticket_utils_null,
13110
General Admission
id13110,
seatingchart{ "medium":"https://s3.amazonaws.com/media.ticketevolution.com/configurations/default_maps/ga_500.jpg", "medium": "null",
"large": |
|
"https://s3.amazonaws.com/media.ticketevolution.com/configurations/default_maps/ga_1000.jpg"}} ""long_term_popularity_score": |
|
"" category{ url/categories/131",
"occurs_at_local": "2023-08-20T00:00:00-05:00",
" |
|
id"131 "2023-08-20T00:00:00Z",
"owned_by_office": false,
" |
|
parent{"url":"/categories/24","24",
parent{
"louisville-bats",
"slug_url": "/ |
|
categories1 "id1/performers/14029",
"name": "Louisville Bats"
|
|
"parent":null, name"Sports" },name"Golf"}namePGA"
},state"shown "/performers/iowa-cubs",
"url": "/ |
|
events376255"2013 Barclays Golf",notesnull,"occurs_at":"2013-08-21T08:00:00Z",id376255 1.37,
"products_count": 897,
|
|
"performances":[ "products_eticket_count": 704,
|
|
{ "promotion_label": null,
"state": "shown",
|
|
performer{ "updated_at": "2022-10-11T21:05:37Z",
"url": "/ |
|
performers25395 name"The Barclays Golf" 4735,
"slug": "principal-park",
" |
|
id25395
}, "slug_url": "/venues/principal-park",
" |
|
primarytrue
"Principal Park",
"location": "Des Moines, |
|
} ]"time_zone": "America/Chicago"
},
|
|
], perpage100,"total_entries":6