Allows searching through venues.
api_key (Required)
Your API application key. If you don't have one,
create one.
search_text (Optional)
The search string to use when looking for venues. Supports quoted phrases and blank values for searching all venues. Please restrict by another parameter when using blank values.
location (Optional)
Only for use in proximity search within the US, the location parameter, if provided, will attempt to restrict search results to areas near that location. This may either be formatted as a comma-separated latitude and longitude (i.e. "37.821, -111.179"), or a fulltext location similar to the following:
- City, State
- City, State, Zip
- Zip
- Street, City, State
- Street, City, State, Zip
- Street, Zip
Any search that uses the location parameter will add the additional data elements "distance" and "distance_units" to the result set.
radius (mi) (Optional, Default: 50mi., Max: 100mi.)
If location is specified, then event.search will look for a radius parameter. Otherwise, it will use 50mi. as the radius of the search.
country_id (Numeric, Optional)
The country_id of the event, used to narrow down the responses. To get a country_id, try the metro.getCountryList function.
state_id (Numeric, Optional)
The state_id of the event, used to narrow down the responses. To get a state_id, try the metro.getStateList function.
metro_id (Numeric, Optional)
The metro_id of the event, used to narrow down the responses. To get a metro_id, try the metro.getList function.
per_page (Numeric, Optional, Default = 100)
Number of results to return per page. Max is 100 per page.
page (Numeric, Optional, Default = 1)
The page number of results to return.
sort (One of name-desc, name-asc, distance-asc, distance-desc, Default = name-asc)
The field and direction on which to sort the results. Distance sorts must ONLY be used if location is specified.
Within the response, several geographical parameters have been added that refer to the geolocation of the underlying venue of the event. These include latitude and longitude, as well as geocoding_precision, which specifies the precision to which the venue address could be found and geocoded, and also the geocoding_ambiguous parameter, which serves as a warning that the geocoding is likely to be erroneous.
Any venue that could not be geocoded at all (i.e. non-US venues) will have blank values in the fields..