Welcome, Guest Sign In | Sign Up | Help
Upcoming API Documentation
Currently, the use of these APIs are restricted to non-commercial use only. If you'd like to use it for commercial purposes, please contact us first.
venue.search [HTTP GET]
Allows searching through venues.
Arguments
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.

Response Notes

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 will have blank values in the fields.

Example Response
<?xml version="1.0" encoding="UTF-8"?>
<rsp stat="ok" version="1.0">
  <venue id="5" name="Troubadour" address="9081 Santa Monica Blvd" city="Hollywood" 
   state="ca" zip="90069" country="us" url="http://www.troubadour.com/" 
   description="" user_id="1" private="0"
   latitude="37.5319" longitude="-122.335" geocoding_precision="address" 
   geocoding_ambiguous="0"
   state_name="California" state_id="5" 
   country_name="United States" country_id="1"
   />
  <venue id="10655" name="Cafe - de Troubadour" address="Capucijnenstraat
   54" city="Tilburg" state="nb" zip="" country="nl" 
   url="http://www.jamesonquiznight.com" description="" 
   user_id="20176" private="0"
   latitude="37.7276" longitude="-122.394" geocoding_precision="address" 
   geocoding_ambiguous="0"
   state_name="Noord Brabant" state_id="295" 
   country_name="The Netherlands" country_id="91"
   />
</rsp>		
Error Codes (sent in HTTP Response Header)
403 Not Authorized:
  • Invalid authentication parameters - either that token was not found, or it may be deactivated. Please contact us for support.

404 Not Found:
  • Missing valid api_key - Please create an API key using the above link.
  • Your api_key is inactive or not found - Please contact us for support.
  • Invalid search_text parameter - search_text is required.
  • Invalid country_id parameter - country_id must be numeric and refer to a valid country.
  • Invalid state_id parameter - state_id must be numeric and refer to a valid state.
  • Invalid metro_id parameter - metro_id must be numeric and refer to a valid metro.
  • Invalid user_id parameter
  • Invalid per_page parameter
  • venue.search only supports 100 results per page - per_page may not exceed 100.
  • Invalid page parameter - page must be numeric.
  • Invalid sort parameter
  • Search location could not be geocoded or was formatted improperly. You can either pass an address. See the formatting examples at http://upcoming.yahoo.com/services/api/event.search.php.
  • Search location was ambiguously geocoded. Please provide more detail in your search location.
  • Invalid radius parameter. Must be a single numeric value equal to the miles of proximity to search within.
  • Invalid radius parameter. Your radius exceeds the maximum allowed on a proximity search (100 miles).
Tools
Upcoming Badges for Your Blog/Website | Invite Friends | Groups | Developers API
Help
News Blog | Community Guidelines | FAQ | Contact Us | Suggestion Board