allCitiesNetwork.com | API | documentation | events | search

search

Returns a list of events that match the specified query.

URL

http://allcitiesnetwork.com/events/search

Format

xml

HTTP Method

GET

Requires Authentication

true

Parameters
  • apikey: Required. Your 32 character apikey string.
  • q: Optional. Search terms included in events to return. Remove a search term with a negative.
    • Example: q=music+-country
  • greedy: Optional. Setting to true will require all words in q parameter are part of returned events. Default is 0.
    • Example: q=basketball+football&greedy=1 Will return only events with basketball and football in the name or keywords.
  • limit: Optional. The number of events to return. Maximum limit is 100, default is 10.
  • page: Optional. Specify the page of results. Page is determined based on given limit amount and total events of current query. Default is 1.
  • sort: Optional. The order in which to sort returned events. Possible values are name, name-desc, modified, modified-desc, start-date, start-date-desc. Defaults to start-date.
  • date: Optional. The parameter value is specified by "YYYYMMDD-YYYYMMDD". Also accepted is "today", "tomorrow" or any month name, such as "april". Using a month name will automatically return the next upcoming of that month, if it has passed for the current year. Default is today's date through a month from today.
  • zip: Optional. Returns events within the zipcodes provided. Specify a five-digit zipcode "12345", a range of zipcodes "12345-12349", or remove a zipcode with a negative "-12345". Separate the list with commas.
    • Example: zip=11111,12345-12349,-12347
  • geo: Optional. Returns events located within a given radius of the given latitude/longitude. The parameter value is specified by "latitide,longitude,radius", where radius units are miles. Defaults to 50 mile radius of the site you originally signed up on.
    • Example: geo=45.46494,-98.48075,25
  • categories: Optional. Comma separated list of category id's to query. Negative values remove the category. Defaults to all categories.
    • Example: categories=1,-40
  • locations: Optional. Comma separated list of location id's to query. Negative values remove the location. Defaults to all locations.
  • users: Optional. Comma separated list of user id's to query. Negative values remove the user. Defaults to all users.
  • favorites: Optional. When set to true, returns events based on favorites of your account. Supercedes categories, locations and users parameters.
Example Queries
  • Containing a word: http://allcitiesnetwork.com/events/search?apikey=yourkey&q=community
  • From a specific location: http://allcitiesnetwork.com/events/search?apikey=yourkey&locations=1
  • Today's events in arts & entertainment: http://allcitiesnetwork.com/events/search?apikey=yourkey&date=today&categories=1
Error Responses

Error responses are returned with events, and are self-explanatory. Defaults will be used if there is a problem with the parameters, so events may be given even if there is a problem with the request.