Versions Compared

Key

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

...

Name
Description
Type
Presence
LocationConditionals
nameExact name of the Venue. Use Venues / Search when searching for a Venue by name.StringOptionalQueryNo
popularity_scoreVenue's popularity ratingDecimalOptionalQueryYes
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.DecimalOptionalQueryNo
lon
ipInfer lat and lon by location of IP address for geolocated searches.StringOptionalQueryNo
postal_codeInfer lat and lon by location of postal code for geolocated searches. Control size of geolocation area using within.StringOptionalQueryNo
city_stateInfer lat and lon by location of city and state for 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

...