Developers Information - API & Web Services
API Method /event_search
This method looks for events by keyword. Only public events are listed.
Arguments
- authentication
- This method controls access via optional user authentication.
- keywords string optional
- The search keywords.
- category string optional
- Event categories (comma seperated): conference, conventions, entertainment, fundraisers, meetings, other, performances, reunions, sales, seminars, social, sports, tradeshows, travel, religion, fairs, food, music, recreation.
- addressstring optional
- The venue address.
- citystring optional
- The venue city.
- region stringoptional
- The venue state/province/county/territory depending on the country. 2-letter state code is required for US addresses.
- postal_codestring optional
- The postal/zip code of the venue.
- countrystringoptional
- 2-letter country code, according to the ISO 3166 format.
- withinintegeroptional
- If "within" is set and the "city" or "zipcode" resolve to a specific geolocation, the search will be restricted to the specified within radius. The sorting default will be set to "distance".
- within_unitstringoptional
- If within is set, you can specify the unit to use: "M" for miles, or "K" for kilometers. By default, the API will use miles.
- latitudefloatoptional
- If "within" is set you can limit your search to wgs84 coordinates (latitude, Longitude).
- longitudefloatoptional
- If "within" is set you can limit your search to wgs84 coordinates (latitude, Longitude).
- datestringoptional
- The event start date. Limit the list of results to a date range, specified by a label or by exact dates. Currently supported labels include: "All", "Future", "Past", "Today", "Yesterday", "Last Week", "This Week", "Next week", "This Month", "Next Month" and months by name, e.g. "October". Exact date ranges take the form "YYYY-MM-DD YYYY-MM-DD", e.g. "2008-04-25 2008-04-27".
- date_created stringoptional
- The date range the event was created, specified by a label or by exact dates. Currently supported labels include: "Today", "Yesterday", "Last Week", "This Week", "This Month". Exact date ranges take the form "YYYY-MM-DD YYYY-MM-DD", e.g. "2008-04-25 2008-04-27".
- date_modified stringoptional
- The date the event was last modified, specified by a label or by exact dates. Currently supported labels include: "Today", "Yesterday", "Last Week", "This Week", "This Month". Exact date ranges take the form "YYYY-MM-DD YYYY-MM-DD", e.g. "2008-04-25 2008-04-27".
- organizer stringoptional
- The organizer name.
- max integeroptional
- Limit the number of events returned. Maximum limit is 100 events per page. Default is 10.
- count_only booleanoptional
- Only return the total number of events ("true" or "false"). Default is "false".
- sort_by stringoptional
- Sort the list of events by "id", "date", "name", "city". The default is "date".
- page integeroptional
- Allows for paging through the results of a query. Default is 1.
- since_id integeroptional
- Returns events with id greater than "since_id" value. Default is 1.
- tracking_link stringoptional
- The tracking link code to add to the event URLs.
Example Request
https://www.eventbrite.com/xml/event_search?...&keywords=computer&city=San+Francisco&date=This+month
Output parameters
This method returns XML with the following structure:
- summary node
- The search results summary with the following structure:
- first_event integer
- The first event ID returned.
- last_event integer
- The last event ID returned.
- num_showing integer
- The number of events showing on page.
- total_items integer
- The number of events matching search criteria.
- events array
- Array of events with the following structure:
- id integer
- The event ID.
- title string
- The event title.
- description string
- The event description.
- category string
- The event category.
- tags string
- The event tags/keywords.
- start_date string
- The event start date and time, in ISO 8601 format (e.g., "2007-12-31 23:59:59").
- end_date string
- The event end date and time, in ISO 8601 format (e.g., "2007-12-31 23:59:59").
- timezone string
- The event timezone, as listed in the Olson timezones database (e.g. "America/New_York").
- created string
- The date and time the event was created, in ISO 8601 format (e.g., "2007-12-31 23:59:59").
- modified string
- The date and time the event was last modified, in ISO 8601 format (e.g., "2007-12-31 23:59:59").
- privacy integer
- 0 for a private event, 1 for a public event.
- password string
- Reserved for private event only.
- capacity integer
- The total event capacity.
- url string
- The event registration URL.
- logo string
- The event logo URL.
- logo_ssl string
- The event logo URL for secure applications.
- status string
- The event status ("draft", "live", "started", "ended", or "canceled").
- background_colorstring
- Custom hexadecimal color for your registration page. Format: FFFFFF without the pound
- text_colorstring
- Custom hexadecimal color for your registration page. Format: FFFFFF without the pound
- link_colorstring
- Custom hexadecimal color for your registration page. Format: FFFFFF without the pound
- title_text_colorstring
- Custom hexadecimal color for your registration page. Format: FFFFFF without the pound
- box_background_colorstring
- Custom hexadecimal color for your registration page. Format: FFFFFF without the pound
- box_text_colorstring
- Custom hexadecimal color for your registration page. Format: FFFFFF without the pound
- box_border_colorstring
- Custom hexadecimal color for your registration page. Format: FFFFFF without the pound
- box_header_background_colorstring
- Custom hexadecimal color for your registration page. Format: FFFFFF without the pound
- box_header_text_colorstring
- Custom hexadecimal color for your registration page. Format: FFFFFF without the pound
- venue
- The event venue with the following structure:
- id integer
- The venue ID.
- name string
- The venue name.
- address string
- The venue address.
- address_2 string
- The venue address (continued).
- city string
- The venue city.
- region string
- The venue state/province/county depending on the country.
- postal_code string
- The venue postal code.
- country string
- The venue country name.
- country_code string
- The venue country code, in 2-letter ISO 3166 format (e.g., "US").
- longitudefloat
- The venue GeoLocation in WGS84 (Longitude).
- latitudefloat
- The venue GeoLocation in WGS84 (Latitude).
- Lat-Long string
- The venue GeoLocation in WGS84 (Latitude/Longitude).
- organizer
- The event organizer with the following structure:
- id integer
- The organizer ID.
- name string
- The organizer name.
- description string
- The organizer description.
- url string
- The organizer URL.
- tickets array
- Array of ticket types available for this event with the following structure:
- id integer
- The ticket ID.
- name string
- The ticket name.
- description string
- The ticket description.
- type integer
- 0 for fixed-price tickets, 1 for donations.
- currency string
- The ticket currency, in 3-letter ISO 4217 format (e.g., "USD").
- price float
- The ticket price (not provided if the ticket is a donation).
- start_date integer
- The date and time when ticket sales start, in ISO 8601 format (e.g., "2007-12-31 23:59:59").
- end_date integer
- The date and time when ticket sales stop, in ISO 8601 format (e.g., "2007-12-31 23:59:59").
- quantity_available integer
- Number of tickets for sale (requires authentication).
- quantity_sold integer
- Number of tickets sold (requires authentication).
- visible boolean
- Flag indicating if the ticket is visible on the event registration page.
Example XML Response
<?xml version="1.0" encoding="utf-8" ?> <search> <summary> <filters> <city>New York</city> <country>US</country> </filters> <first_event>908163459</first_event> <last_event>702165483</last_event> <total_items>10</total_items> </summary> <event> <id>908163459</id> <title>Best NYC New Year's Party</title> <description>Come spend New Year's Eve with us!</description> <category>conferences</category> <tags>new year, party</tags> <start_date>2008-12-31 20:00:00</start_date> <end_date>2009-01-01 06:00:00</end_date> <timezone>US/Eastern</timezone> <created>2007-11-03 12:47:06</created> <modified>2008-01-09 10:12:15</modified> <privacy>1</privacy> <url>http://nycparty.eventbrite.com</url> <logo>http://images.eventbrite.com/logos/908163459.jpg</url> <logo_ssl>https://www.eventbrite.com/php/logo.php?id=908163459.jpg</url> <venue> <id>1</id> <name>Madison Square Garden</name> <address>4 Penn Plaza</address> <address_2></address_2> <city>New York</city> <region>NY</region> <postal_code>10001</postal_code> <country>United States</country> <country_code>US</country_code> <Lat-Long>47.123 / 3.34</Lat-Long> </venue> <organizer> <id>65739440</id> <name>New Year's NYC Team</name> <description>We organizer the best parties in town!</description> <url>http://www.eventbrite.com/org/65739440</url> </organizer> <tickets> <ticket> <id>45264859</id> <name>VIP Registration</name> <description>Access to VIP Rooms</description> <type>0</type> <currency>USD</currency> <price>199.99</price> <start_date>2008-10-24 00:00:00</start_date> <end_date>2008-12-30 23:00:00</end_date> <quantity_available>100</quantity_available> <quantity_sold>0</quantity_sold> </ticket> </tickets> </event> </search>
Error Codes
This method may return these errors in an error document:
- Authentication Error
- The specified user was not found or the login credentials didn't match.
- Not Found
- The keyword(s) provided return no event.
- Country error
- The 2-letter country code provided is invalid.
- Region error
- The 2-letter state code provided is invalid (US only).
- DateRange error
- The date range provided is invalid (check document for valid values).
- Date error
- The date provided is invalid.
- Distance error
- Distance must be a number.
- No events found within the specified distance.
- Invalid unit. "M" or "K" are accepted values.
- Missing city or zip code for location.