Search
Request
Search returns addresses or Points of Interest located around a specified coordinate location.
GET https://apis.location.studio/geo/v2/search/json
Required Parameters
api_key |
String |
Your Location Studio API Key |
search_center |
String |
search_center is used for a proximity based match to the address. The search will lookup addresses within 100 miles of the search center to find the specified address using a partial match. If the address is further than this distance, greater detail must be specified in the address in order for the search to find the location. |
query |
String |
Street address of the location to return the lat/long for. This can be a full or partial address. |
type |
String |
Must be set to 'address-only' to perform a forward gecode operation. |
Response
Description
Search results are returned in a place array unless matches are not found in which case HTTP status 204 is returned. Please see the listing of Status Codes for additional details. If an error does not occur and there are matches, the response consists of one or more place elements.
Each result within the place array has a name property and may contain the following fields:
-
name
- Name of the POI. -
distance
- distance from the search_center in meters. Alternatively, the distance will be calculated from the user_position if it is provided. -
location
- contains the following information:-
city city
- name of the returned address. -
coordinate
- contains the latitude and longitude value. -
country
- The country name in long form. For example, "United States". -
country_code
- The ISO 3166-1 three character country code. For example, "USA". -
formatted_address
- The returned address formatted as a single line of text. For example, "25381 Alicia Pky, Laguna Hills, CA 92653, USA". -
house_number
- The house number in the street. For example, "25381" in "25381 Alicia Pky". -
postal
- The postal code. -
state
- state name of the returned address. -
street
- street name of the returned address. -
type
- type of the returned address. The following values are supported:-
airport
-
street
-
intersection
-
-
-
accuracy
- Accuracy of the match. Supported only for address match ("type=address-only"). Possible values are 1 to 10 where 10 is the highest. -
phones
- List of phone numbers associated with a place. The properties of phone are:-
type
- Type of phone number. Can be any one of 'primary', 'secondary', 'national', 'mobile' or 'fax'. -
area
-
country
-
ext
- indicates the extension for the telephone number. -
number
-
-
categories
- is an array indicating the categories of the place. For example, "Grocery Stores".-
code
- category code -
name
- category name -
parent_category
-
code
- category code -
name
- category name
-
-
-
brand
- array indicating the brands associated with the place.-
id
- brand id -
name
- brand name
-
-
fuel_price
- List of fuel price details for the place.-
value
- fuel price -
units
- Fuel units. Supported values are “G” for gallon and “L” for liter. -
type
- Type of fuel. Supported values are “r” for regular, “m” for mid-grade, “p” for premium, “d” for diesel, “e” for ethanol-85. -
currency
- Specifies currency units of the price. ISO 4217 Code (http://en.wikipedia.org/wiki/ISO_4217). Example: “USD” for US dollars.
-
-
enhanced_contents
Additional POI content, including advertisement specific information, etc.
-
payment_method
- A comma separated list of payment methods accepted. -
cuisines
- Text description of the cuisines of the restaurant. -
description
- Description of the Business. -
features
- Text description of the features of the business. -
special_features
- Restaurant special features, including amenities and specialities. -
parking
- Text describing parking options. -
price
- Text describing the range of prices for goods / services the business provides. -
reservations
- Text describing the reservations options provided by the business. -
wifi
- Text value indicating whether WiFi is Free or Paid, if available at all. -
dress_code
- Text describing attire restrictions. -
good_for
- Restaurants only: "business", "romance", etc. -
smoking
- Text describing smoking restrictions. -
shuttle_service
- Text describing shuttle service provided by the business. -
tips
- Text describing about tips for the business. Eg “arrive 30 mins early or reserve 2 hours ahead”. -
hours_of_operation_text
- Text describing the hours the business is open. -
business_url
- URL of the Business website. -
thumbnail_photo_url
- URL of the business thumbnail photo to be displayed in smaller views. -
photo_url
- URL of the business large photo. -
photo_url_1
- URL of the business additional photo. -
photo_url_2
- URL of the business additional photo. -
photo_url_3
- URL of the business additional photo. -
photo_url_4
- URL of the business additional photo. -
hours_of_operation_structured
-
day_of_the_week
- 0 (sun), 1(mon) to 6 (sat). -
hours
- contains list of business hours for the given day_of_the_week. If a business has multiple sessions (eg 6 AM to 9 AM, 11AM to 2 PM, 6PM to 9 PM), there will be multiple start-time and end-time for the day.-
start_time Business
- start time for a session. Represented in number of seconds since start of the day. Eg 7 AM will be 25200 (7 * 6 * 60). -
end_time Business
- end time for a session. Represented in number of seconds since start of the day. Eg 9 AM will be 32400 (9 * 6 * 60).
-
-
-
tripadvisor_contents
- Contents from TripAdvisor that require UI attribution. TripAdvisor icon, average ratings, review count must be displayed as per TripAdvisor specifications. User should have an option to go to the TripAdvisor detail page. TripAdvisor Display Requirements.-
iterator_status
- Internal state of the iterator to be used for next and previous page requests. -
exhausted
- Indicates if more results are available for potential next page request. Supported values are "y" (yes) or "n" (no).
-