Page Comparison

Page Properties

Name	Events / Index
Description	Obtain a list of Events that match given conditions.
Type	GET
URL	/v9/events
Credential Type	API\|User
Supports Pagination	Yes

...

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 result in fuzzy full text search. Will NOT work if passed without 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

country_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 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 [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

Note
Deprecated. Use the Events/Stats endpoint instead.

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

If true then only events that have discounted tickets will be returned.

Boolean

Optional

Query

No

Examples

Request

Response

GET /v9/events?city_state=jersey%20city,nj&within=2performer_id=13910&occurs_at.gte=2023-08-19&occurs_at.lte=2023-08-21

Code Block

language	ruby

{
   "current_page": 1,
  "per_page": 100,
  "eventstotal_entries":[ 2,
  "events": [
 {   {
      "productsavailable_eticket_count":0 811,
      "category": {
  "updated_at":"2013-02-19T22:29:13Z",          "products_count":18,
"id": "4",
        "owned_by_officename":false, "Minor         "long_term_popularity_score":0.44967League Baseball",
         "venueslug":{ "minor-league",
           "url": "/venuescategories/62624",
            "name"slug_url":"Liberty National Golf Club",
    "/categories/minor-league",
        "idparent":6262, {
           "locationid": "2"Jersey,
City, NJ"          }"name": "Baseball",
          "configurationslug":{ "baseball",
          "url": "fanvenues_key":null/categories/2",
            "ticket_utils_id":nullslug_url": "/categories/baseball",
            "urlparent":"/configurations/13110", {
            "nameid": "General Admission1",
            "idname":13110 "Sports",
            "seating_chartslug":{ "sports",
              "mediumurl": "https://s3.amazonaws.com/media.ticketevolution.com/configurations/default_maps/ga_500.jpgcategories/1",
               "large"slug_url": "https://s3.amazonaws.com/media.ticketevolution.com/configurations/default_maps/ga_1000.jpg"categories/sports",
            }"parent": null
          },
        }
 "popularity_score":"0",     },
      "categoryconfiguration": {
 
          "urlid":"/categories/131" 11583,
        "url": "/configurations/11583",
        "idname": "131Baseball",
        "fanvenues_key": null,
  "parent":{      "ticket_utils_id": null,
        "urlseating_chart":"/categories/24", {
              "idmedium": "24null",

              "parentlarge":{ "null"
        }
      },
      "urlid":"/categories/1" 2165591,
         "long_term_popularity_score": 0.216,
        "idname": "1",Louisville Bats at Iowa Cubs",
      "notes": "",
      "parent":null"occurs_at_local": "2023-08-19T00:00:00-05:00",
        "occurs_at": "2023-08-19T00:00:00Z",
         "name"owned_by_office":"Sports" false,
      "performances": [
      },  {
             "nameperformer":"Golf" {
            "id": }14029,
            "nameslug": "PGA"
 louisville-bats",
       },          "state"slug_url":"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_scorename":"15.08", "Louisville Bats"
         "category":{  },
          "urlprimary":"/categories/131", false
        },
      "id":"131",  {
          "parentperformer": {
               "urlid":"/categories/24",
 13910,
              "idslug": "24iowa-cubs",
               "parent"slug_url":{
    "/performers/iowa-cubs",
              "url": "/categoriesperformers/113910",
            "name": "Iowa Cubs"
   "id":"1",        },
          "parentprimary":null, true
        }
      ],
 "name":"Sports"       "popularity_score": 2.78,
        }"products_count": 811,
      "products_eticket_count": 459,
       "namepromotion_label": "Golf"Brennen Davis Bobblehead Giveaway",
         },
   "state": "shown",
        "namestubhub_id":"PGA" null,
        },
  "updated_at": "2023-07-25T14:41:34Z",
      "stateurl": "shown/events/2165591",
  
      "urlvenue":"/events/376254", {
        "nameid":"2013 Barclays Golf" 4735,
        "slug": "notesprincipal-park":null,

        "occurs_aturl":"2013-08-22T08:00:00Z "/venues/4735",
        "slug_url": "id":376254,
/venues/principal-park",
        "performancesname":[ "Principal Park",
        "location": "Des {
     Moines, IA",
         "performertime_zone":{ "America/Chicago"
      },
      "discount_magnitude": 0
   "url":"/performers/25395" },
    {
      "available_count": 897,
      "namecategory":"The Barclays Golf", {
        "id": "4",
        "idname":25395 "Minor League Baseball",
        "slug": "minor-league",
  },      "url": "/categories/4",
        "primaryslug_url":true "/categories/minor-league",
        "parent": {
  }        "id": "2",
]       },   "name": "Baseball",
  {        "slug":  "products_eticket_count":0,baseball",
          "updated_aturl":"2013-02-19T22:29:13Z "/categories/2",
          "productsslug_counturl":24 "/categories/baseball",
          "owned_by_officeparent":false, {
            "long_term_popularity_score":0.42858,id": "1",
            "venuename":{ "Sports",
            "urlslug": "/venues/6262sports",
            "nameurl":"Liberty National Golf Club "/categories/1",
            "idslug_url":6262 "/categories/sports",
            "locationparent":"Jersey City,null
NJ"          },
        }
"configuration":{      },
      "fanvenues_keyconfiguration":null, {
           "ticket_utils_id":null,
 11583,
          "url": "/configurations/1311011583",
   
        "name": "General AdmissionBaseball",
   
        "idfanvenues_key":13110,
    null,
        "seatingticket_utils_chartid":{ null,
        "seating_chart": {
    "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" "null"
        }
    }  },
      "id": }2165592,
         ""long_term_popularity_score":" 0".172,
         "categoryname":{ "Louisville Bats  at Iowa Cubs",
      "urlnotes": "/categories/131",
      "occurs_at_local": "2023-08-20T00:00:00-05:00",
      "idoccurs_at":"131 "2023-08-20T00:00:00Z",
      "owned_by_office": false,
      "parentperformances":{ [
        {
      "url":"/categories/24",    "performer": {
            "id":"24",
  14029,
             "parentslug":{
      "louisville-bats",
            "slug_url": "/categoriesperformers/1louisville-bats",
                  "id"url": "1/performers/14029",
            "name": "Louisville Bats"
   "parent":null,       },
           "nameprimary":"Sports"   false
        },
   },     {
          "nameperformer":"Golf" {
            "id": }13910,
            "nameslug": "PGA"
   iowa-cubs",
     },          "stateslug_url":"shown "/performers/iowa-cubs",
            "url": "/eventsperformers/37625513910",
            "name":"2013 Barclays Golf", "Iowa Cubs"
          },
          "notesprimary":null, true
        }
   "occurs_at":"2013-08-21T08:00:00Z",   ],
      "idpopularity_score":376255 1.37,
      "products_count": 897,
 "performances":[     "products_eticket_count": 704,
      { "promotion_label": null,
      "state": "shown",
       "performerstubhub_id":{ null,
          "updated_at": "2022-10-11T21:05:37Z",
      "url": "/performersevents/253952165592",
      "venue": {
          "nameid":"The Barclays Golf" 4735,
        "slug": "principal-park",
        "idurl":25395
           "/venues/4735",
    },       "slug_url": "/venues/principal-park",
        "primaryname":true
 "Principal Park",
        "location": "Des Moines, }IA",
         ]"time_zone": "America/Chicago"
      },
   ],    "perdiscount_pagemagnitude":100, 0
    }
 "total_entries":6 ]
}

Versions Compared

Old Version 32

New Version Current

Key

Examples