Versions Compared

Old Version 1

changes.mady.by.user Don Pflaster

Saved on

compared with

New Version Current

changes.mady.by.user J Cobb (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Page Properties
labelapi_docs_venues
NameVenues / Index
DescriptionList all venues conforming to passed parameters.Obtain a list of Venues that match given conditions
TypeGET
URL/v9/venues
Credential TypeAPI|User
Supports PaginationYes

Long Description

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

Parameters

of venue (requires corresponding lon)
Name
Description
Value Type
RequiredPresence
LocationConditionals
nameExact name of the venueVenue. Use Venues / Search when searching for a Venue by name.StringOptionalQueryNo
popularity_scoreVenue's popularity rating, imported from SeatGeekdecimalDecimalOptionalQueryYes
disabled_atDate/time venue was disabledDate (ISO_8601)OptionalQueryYes
deleted_atDate/time venue was deletedDate (ISO_8601)

Optional

QueryYes
updated_atDate/time venue was updatedDate (ISO_8601)OptionalQueryYes
first_letterFilters venues by the first letter passedCharOptionalQueryNo
latLatitude & longitude for geolocated searches. Control size of geolocation area using within. Must supply both.DecimalOptional
lonLongitude of venue (requires corresponding lat)DecimalOptional
QueryNo
lon
ipInfer lat and lon by location of IP Addressaddress for geolocated searches.StringOptionalQueryNo
postal_codeInfer lat and lon by location of postal codefor geolocated searches. Control size of geolocation area using within.StringOptionalQueryNo
city_stateInfer lat and lon by location of city and statefor geolocated searches. Control size of geolocation area using within.StringOptionalQueryNo
withinRadius from lat and lon to search in miles for geolocated searches (default 15)IntegerOptionalQueryNo
order_byPass in the parameter that you want to order by and the sorting order (Ex. :order_by => "venues.popularity_score DESC")StringOptionalQueryNo

Examples

RequestResponse
/v9/venues?lat=40.7281&lon=-74.0781&within=1 

 

Code Block
themeConfluence
languageruby
{
   "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
}