Search API
This is the core API and is still in Beta 1, however any changes that alter the core functionality or parameters will be made with at least 30 days notice to registered developers.
To use the API, make an HTTP GET request to http://www.sitorsquat.com/sitorsquat/api/search with the following parameters being used, also all responses will be in JSON format:
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| sosdak | string | required | The "SitOrSquat Developer Access Key" (sosdak) that was provided when access to the SitOrSquat API was granted. |
| latitude | double | required | The latitude coordinate for the center point of the search. |
| longitude | double | required | The longitude coordinate for the center |
| radius | float | optional | The radius in miles to search from the center point. This defaults to 5mi. |
| maxResults | int | optional | The maximum number of results to return, the default is 10 and the maximum number the API will return is 50. |
The JSON response will be an array with the following description
| Name | Data Type | Description |
|---|---|---|
| locationName | string | The name of the facility's location, i.e. "Starbucks" |
| latitude | double | Latitude of the facility |
| longitude | double | Longitude of the facility |
| address | string | The textual address of the location |
| phoneNumber | string | The phone number of the location. If it is available in our system. |
| distance | double | The distance in miles from the center point of the search to the location |
| avgRating | float | Average rating for the current facility by users, 0.0 means unrated |
| status | int | The current status as of the moment requested (if available). 0=Unknown, 1=Open (The facilities normal business hours indicate it is open at this time), 2=Closed (Business hours indicate it is currently closed) |
| webUrl | string | URL to link to in normal web browser |
| mobileUrl | string | The mobile url to link to from any from or portable device with internet connectivity |
| iphoneUrl | string | The iPhone url to link to from an iPhone or iPod touch |
Please email any questions to support@sitorsquat.com