Page Properties | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
|
Long Description
Obtain a list of venues that match certain given conditions. Events occur Events occur at venues, and are directly related.
Parameters
Name | Description | Value Type | RequiredPresence | Location | Conditionals | ||||
---|---|---|---|---|---|---|---|---|---|
name | Exact name of the venueVenue. Use Venues / Search when searching for a Venue by name. | String | Optional | Query | No | ||||
popularity_score | Venue's popularity rating | decimalDecimal | Optional | Query | Yes | ||||
disabled_at | Date/time venue was disabled | Date (ISO_8601) | Optional | Query | Yes | ||||
deleted_at | Date/time venue was deleted | Date (ISO_8601) | Optional | Query | Yes | ||||
updated_at | Date/time venue was updated | Date (ISO_8601) | Optional | Query | Yes | ||||
first_letter | Filters venues by the first letter passed | Char | Optional | Query | No | ||||
lat | Latitude | of venue (requires corresponding lon)& longitude for geolocated searches. Control size of geolocation area using within . Must supply both. | Decimal | Optional | lon | Longitude of venue (requires corresponding lat) | Decimal | OptionalQuery | No |
lon | |||||||||
ip | Infer lat and lon by location of IP Addressaddress for geolocated searches. | String | Optional | Query | No | ||||
postal_code | Infer lat and lon by location of postal codefor geolocated searches. Control size of geolocation area using within . | String | Optional | Query | No | ||||
city_state | Infer lat and lon by location of city and statefor geolocated searches. Control size of geolocation area using within . | String | Optional | Query | No | ||||
within | Radius from lat and lon to search in miles for geolocated searches (default 15) | Integer | Optional | Query | No | ||||
order_by | Pass in the parameter that you want to order by and the sorting order (Ex. :order_by => "venues.popularity_score DESC") | String | Optional | Query | No |
Examples
Request | Response | |||||||
---|---|---|---|---|---|---|---|---|
/v9/venues?lat=40.7281&lon=-74.0781&within=1 | ||||||||
|
|