Radius Search Request

The Radius Search service allows a search of a dataset to be made by inputting the latitude/longitude pair or by giving a single-line origin address.

Contents

Parameters

Below are request and response parameters that are unique to a Radius Search. Refer to the Common Parameters page for information on request and response parameters common in all searches.

Request Parameters

Name Description
origin
Location		 This is the origin location of the request. A valid origin can be any kind of single-line address.

In order to use compressed or simple formatted latitude/longitude pairs, refer to the Base Search documentation.
radius
Double		 Distance from the origin to search. The units for this parameter are set by the "units" parameter which can be found in the Common Parameters documentation.

If sending a request with JSON or XML, this parameter must go into the "options" object of the JSON or XML body.

Response Parameters

Name Description JSON Example Return Value(s) XML Example Return Value(s)
origin
Location		 This is the origin of the search radius 

{
  "geocodeQualityCode":"A5XAX",
  "type":"s",
  "adminArea3":"PA",
  "street":"",
  "dragPoint":false,
  "sideOfStreet":"N",
  "adminArea4Type":"County",
  "adminArea3Type":"State",
  "postalCode":"",
  "latLng":{
	"lat":40.0378,
	"lng":-76.305801
  },
  "adminArea1":"US",
  "adminArea5Type":"City",
  "adminArea1Type":"Country",
  "adminArea5":"Lancaster",
  "adminArea4":"Lancaster County",
  "linkId":0,
  "geocodeQuality":"CITY"
}


<origin>
  <street/>
  <adminArea5 type="City">
	Lancaster
  </adminArea5>
  <adminArea3 type="State">
	PA
  </adminArea3>
  <adminArea4 type="County">
	Lancaster County
  </adminArea4>
  <postalCode/>
  <adminArea1 type="Country">
	US
  </adminArea1>
  <geocodeQuality>
	CITY
  </geocodeQuality>
  <geocodeQualityCode>
	A5XAX
  </geocodeQualityCode>
  <dragPoint>false</dragPoint>
  <sideOfStreet>N</sideOfStreet>
  <linkId>0</linkId>
  <type>s</type>
  <latLng>
	<lat>40.0378</lat>
	<lng>-76.305801</lng>
  </latLng>
</origin>
radius
Double		 Distance from the origin searched. radius: 20.0 <radius>20.0</radius>

Point in Polygon

In addition to searching around a point, the Radius Search can also be used to check if a point lies within the bounds of a search data item. This is accomplished by setting the radius parameter to 0. Below is an example.


Origin: Map Data to Search:

(Search will be displayed below)

 

Advanced Radius Search Sample


Options Value(s)
Origin:
Ambiguities:
Radius:
Units:
Max Matches:
Shape Format:
Current Page:
Page Size:
Input Format:
Output Format:  (Demonstration only... will always return JSON)
Map Data:
Hosted Data:
Remote Data:

(Output will be displayed below)


  © MapQuest, Inc. All rights reserved.    Privacy Policy | Terms of Use