latestOpenAPI 3.1.02026-07-248941352.6 KB

d3f744f55ed7

Events

Event Search

Returns events that match search criteria

get/v3/events

Query parameters

localestring

Locale code in the format of {language code}_{country code}. See the list of supported locales.

offsetinteger

Offset the list of returned results by this amount.

limitinteger

Number of events results to return. By default, it will return 3. Maximum is 50.

sort_by'asc' | 'desc'

Sort by either descending or ascending order.

sort_on'popularity' | 'time_start'

Sort on popularity or time start.

start_dateinteger

Unix timestamp. Will return events that only begin at or after the specified time.

end_dateinteger

Unix timestamp. Will return events that only end at or before the specified time.

categoriesstring[]

List of category aliases.

is_freeboolean

Filter whether the events are free to attend. By default no filter is applied so both free and paid events will be returned.

excluded_eventsstring[]

List of event ids. Events associated with these event ids in this list will not show up in the response.

locationstring

Required if either latitude or longitude is not provided. This string indicates the geographic area to be used when searching for events. Examples: "New York City", "NYC", "350 5th Ave, New York, NY 10118". Events returned in the response may not be strictly within the specified location.

latitudenumber

Required, if location is not provided. Latitude of the location to search from. If latitude is provided, longitude is required too.

longitudenumber

Required if location is not provided. Longitude of the location to search from. If longitude is provided, latitude is required too.

radiusinteger

Search radius in meters. If the value is too large, a AREA_TOO_LARGE error may be returned. The max value is 40000 meters (about 25 miles).

Response

One more more events were found.

eventsSchema[] required— unresolved $ref

List of events found matching search criteria.

totalinteger required

Total number of events returned based on search criteria.