Methods
Method detail for: getGeoListByRadius
This request requires you to submit a latitude and longitude coordinate pair, and a radius in miles. The API will spatially determine the number of objects that are wholly or partially within that radius and return their IDs.
Valid Datasets
| Dataset | Dataset Details | Method Parameters |
|---|---|---|
| Counties | Click To View | Click To View |
| Census CBSAs | Click To View | Click To View |
| Canada Divisions | Click To View | Click To View |
| Maponics College Campus Boundaries | Click To View | Click To View |
| Canada Provinces | Click To View | Click To View |
| Carrier Routes | Click To View | Click To View |
When calling this dataset using this method, use these parameters:
(Note: Items marked with * are required) | ||
| Carrier Route Centroids | Click To View | Click To View |
When calling this dataset using this method, use these parameters:
(Note: Items marked with * are required) | ||
| Canada Subdivisions | Click To View | Click To View |
| Maponics Destination & Venue Boundaries | Click To View | Click To View |
| Maponics Hospital Boundaries | Click To View | Click To View |
| Maponics Metro Boundaries | Click To View | Click To View |
| Census MCDs | Click To View | Click To View |
| Maponics City Points | Click To View | Click To View |
| Maponics Neighborhood Boundaries Europe | Click To View | Click To View |
| Maponics Neighborhood Boundaries North America | Click To View | Click To View |
| Maponics Neighborhood Centroids North America | Click To View | Click To View |
| Maponics Neighborhood Boundaries Rest Of World | Click To View | Click To View |
| Maponics Neighborhood Boundaries Worldwide | Click To View | Click To View |
| Census Places | Click To View | Click To View |
| Maponics +Residential Boundaries | Click To View | Click To View |
| US States | Click To View | Click To View |
| Maponics School Attendance Zone Boundaries | Click To View | Click To View |
| Maponics School District Boundaries | Click To View | Click To View |
| Maponics Subdivision Boundaries | Click To View | Click To View |
| Maponics Shopping Boundaries | Click To View | Click To View |
| ZIP Codes | Click To View | Click To View |
| ZIP Code Centroids | Click To View | Click To View |
When calling this dataset using this method, use these parameters:
(Note: Items marked with * are required) | ||
Sample Request and Return Data
<?xml version="1.0" encoding="UTF-8" ?>
<data>
<auth>
<loginname>your_username</loginname>
<key>your_api_key</key>
</auth>
<request>
<dataset>Z</dataset>
<method>getGeoListByRadius</method>
<returnType>xml</returnType>
<parameters>
<lat>40.713734</lat>
<lon>-74.011683</lon>
<radius>1</radius>
<submatch></submatch>
</parameters>
</request>
</data>
{
"data":{
"auth":{
"loginname":"your_username",
"key":"your_api_key"
}
},
"request":[
{
"dataset":"N",
"method":"getGeoListByRadius",
"count":"false",
"returnType":"json",
"parameters":{
"lat":"40.713734",
"lon":"-74.011683",
"radius":"10",
"submatch":"N"
}
}
]
}
<?xml version="1.0" encoding="UTF-8" ?>
<data>
<request>
<item>
<zip>10020</zip>
</item>
<item>
<zip>10110</zip>
</item>
<item>
<zip>10120</zip>
</item>
...
<item>
<zip>10006</zip>
</item>
<item>
<zip>10001</zip>
</item>
<item>
<zip>13417</zip>
</item>
</request>
</data>
[
{
"resultcode":0,
"message":"Return OK",
"requestid":"03-14476",
"request":[
[
{
"zip":"12417"
},
{
"zip":"10024"
},
{
"zip":"11010"
}...{
"zip":"13638"
},
{
"zip":"13664"
},
{
"zip":"13665"
}
]
]
}
]
