Venues / Index

Name	Venues / Index
Description	Obtain a list of Venues that match given conditions
Type	GET
URL	/v9/venues
Credential Type	API\|User
Supports Pagination	Yes

Long Description

Obtain a list of venues that match given conditions. Events occur at venues, and are directly related.

Parameters

Name	Description	Type	Presence	Location	Conditionals
`name`	Exact name of the Venue. Use Venues / Search when searching for a Venue by name.	String	Optional	Query	No
`popularity_score`	Venue's popularity rating	Decimal	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 & longitude for geolocated searches. Control size of geolocation area using `within`. Must supply both.	Decimal	Optional	Query	No
`lon`		Decimal	Optional	Query	No
`ip`	Infer lat and lon by location of IP address for geolocated searches.	String	Optional	Query	No
`postal_code`	Infer lat and lon by location of postal code for geolocated searches. Control size of geolocation area using `within`.	String	Optional	Query	No
`city_state`	Infer lat and lon by location of city and state for geolocated searches. Control size of geolocation area using `within`.	String	Optional	Query	No
`within`	Radius 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

{
   "current_page":1,
   "total_entries":2,
   "venues":[
      {
         "upcoming_events":{
            "last":"2013-01-27 14:00:00",
            "first":"2010-12-04 19:00:00"
         },
         "address":{
            "locality":"Jersey City",
            "postal_code":"07306",
            "label":null,
            "country_code":"US",
            "street_address":"Saint Peters College",
            "created_at":"2012-04-12 03:37:53.735782",
            "latitude":"40.7272951338493",
            "extended_address":"Kennedy Boulevard",
            "location":"Jersey City, NJ",
            "longitude":"-74.0707141693115",
            "region":"NJ"
         },
         "popularity_score":"0.000000",
         "keywords":null,
         "country_code":"US",
         "url":"/venues/9114",
         "updated_at":"2012-10-01 18:00:39.221713",
         "location":"Jersey City, NJ",
         "name":"Yanitelli Center",
         "id":9114
      },
      {
         "upcoming_events":{
            "last":"2011-11-06 08:00:00",
            "first":"2011-11-06 08:00:00"
         },
         "address":{
            "locality":"Jersey City",
            "postal_code":"07306",
            "label":null,
            "country_code":"US",
            "street_address":"54 Journal Square",
            "created_at":"2012-04-12 03:37:55.198502",
            "latitude":"40.7320659",
            "extended_address":null,
            "location":"Jersey City, NJ",
            "longitude":"-74.0641019",
            "region":"NJ"
         },
         "popularity_score":"0.000000",
         "keywords":"",
         "country_code":"US",
         "url":"/venues/4586",
         "updated_at":"2012-05-24 15:20:27.697444",
         "location":"Jersey City, NJ",
         "name":"Landmark Loews Jersey Theatre",
         "id":4586
      }
   ],
   "per_page":100
}