|
Parameter
|
Value
|
Description
|
|
query
|
string (required)
|
The query to search for.
|
|
results
|
integer: default 10, max 20
|
The number of results to return.
|
|
start
|
integer: default 1
|
The starting result position to return (1-based).
|
|
sort
|
relevance (default), title, or distance
|
Sorts the results by the chosen criteria.
|
|
radius
|
float
|
How far (in miles) from the specified location to search for the query terms. The default radius varies according to the location given.
|
|
latitude
|
float: -90 to 90
|
The latitude of the starting location.
|
|
longitude
|
float: -180 to 180
|
The longitude of the starting location. If both latitude and longitude are specified, they will take priority over all other location data. If only one of latitude or longitude is specified, both will be ignored.
|
|
Field
|
Description
|
|
ResultSetMapUrl
|
Currently a placeholder
|
|
ResultSet
|
Contains all of the query responses. Has attributes:
- totalResultsAvailable: The number of query matches in the database.
- totalResultsReturned: The number of query matches returned. This may be lower than the number of results requested if there were fewer total results available.
- firstResultPosition: The position of the first result in the overall search.
|
|
Result
|
Contains each individual response.
|
|
Title
|
Name of the result.
|
|
Address
|
Street address of the result.
|
|
City
|
City in which the result is located.
|
|
State
|
State in which the result is located.
|
|
Phone
|
Phone number of the business, if known.
|
|
Latitude
|
The latitude of the location.
|
|
Longitude
|
The longitude of the location.
|
|
Distance
|
The distance as calculated from the specified lat/long
|
|
NumReviews
|
The total number of reviews available for the business.
|
|
ReviewsFeedUrl
|
The URL for the reviews feed for the business.
|
|
NumEnhancements
|
The total number of reviews available for the business.
|
|
EnhancementsFeedUrl
|
The URL for the full set of enhancements for the business.
|
