API Documentation
Last modified December 3, 2012Introduction
The Dress Code Finder API allows searching of our database of dress code information for over 70,000 restaurants, bars and nightclubs in the USA. The API is currently unauthenticated (and subject to usage limits). It returns results in JSON format.
Search
The core functionality is contained in the search call, accessible at /venues/search.json. The method allows filtering, full text searching, and pagination of results.
Required Parameters
All parameters for the search call are optional.
Optional Parameters
Parameter |
Description |
Example |
|---|---|---|
search_term |
Search the venue name field by specifying a search term. |
search_term=jean |
page |
20 results are returned per page. To access results beyond the first 20, specify an integer > 1. |
page=2 |
latitude |
The latitude of the user's current position. If latitude and longitude parameters are present, the results will automatically be sorted by distance from the position specified. |
latitude=50.282 |
longitude |
The longitude of the user's current position. If latitude and longitude parameters are present, the results will automatically be sorted by distance from the position specified. |
longitude=50.282 |
Examples
Find venues with the partial name "jean":
http://dresscodefinder.com/venues/search.json?search_term=jean
This returns more than 10 results, so either request the next page of results:
http://dresscodefinder.com/venues/search.json?search_term=jean&page=2
To find the results that are closest to a particular place (e.g. the end user's current position), specify latitude and longitude values.
http://dresscodefinder.com/venues/search.json?search_term=jean&latitude=40.7142&longitude=74.0064
Details
If the ID of the venue is known, the details for a single venue can be requested with the details method, accessible at /venues/details.json. The method takes one required parameter, id. This method is useful if you have stored the ID locally and would like to request the current dress code information.
Continuing the example, this call will return the dress code for Jean Georges in New York:
http://dresscodefinder.com/venues/details.json?id=9753
Limits
All methods are subject to request limits. The current limit is 1,000 requests per hour and 5,000 requests per day. These limits may be revised, and additional limits may be imposed, at any time.