Methods
Method detail for: getGeoAttByGeom
This request requires you to submit a latitude and longitude coordinate pairs for the bottom left and top right of a rectangular area. The API will spatially determine the number of objects that are wholly or partially within that area and return a list of attributes for those objects. You may also specify which type of spatial search is performed (INTERSECT/WITHIN). The method defaults to WITHIN..
Valid Datasets
Dataset | Dataset Details | Method Parameters |
---|---|---|
Carrier Routes | Click To View | Click To View |
Carrier Route Centroids | Click To View | Click To View |
Maponics Destination & Venue Boundaries | Click To View | Click To View |
Maponics City Points | 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 |
Census Places | Click To View | Click To View |
Maponics +Residential Boundaries | Click To View | Click To View |
Maponics Shopping Boundaries | Click To View | Click To View |
Maponics Private Schools | Click To View | Click To View |
Maponics Public Schools | Click To View | Click To View |
ZIP Code Centroids | Click To View | Click To View |
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>N</dataset>
<method>getGeoListByGeom</method>
<parameters>
<tl_lat>40.719734</tl_lat>
<tl_lon>-74.011683</tl_lon>
<br_lat>40.713734</br_lat>
<br_lon>-74.00000</br_lon>
<searchType>INTERSECT</searchType>
<fields>neighborhd,nbr_type</fields>
<submatch>N</submatch>
</parameters>
</request>
</data>
{
"data":{
"auth":{
"loginname":"your_username",
"key":"your_api_key"
}
},
"request":[
{
"dataset":"CR",
"method":"getGeoAttByGeom",
"count":"false",
"returnType":"json",
"parameters":{
"tl_lat":"40.719734",
"tl_lon":"-74.011683",
"br_lat":"40.713734",
"br_lon":"-74.00000",
"searchType":"INTERSECT",
"fields":"zipcrid,name",
"submatch":"N"
}
}
]
}
<?xml version="1.0" encoding="UTF-8" ?>
<data>
<request>
<item>
<neighborhd>Goose Island</neighborhd>
<nbr_type>N</nbr_type>
</item>
<item>
<neighborhd>Lincoln Park</neighborhd>
<nbr_type>N</nbr_type>
</item>
<item>
<neighborhd>Near North Side</neighborhd>
<nbr_type>N</nbr_type>
</item>
</request>
</data>
[
{
"resultcode":0,
"message":"Return OK",
"requestid":"01-1453"
},
[
{
"zipcrid":"10013C008",
"name":"NEW YORK"
},
{
"zipcrid":"10007C001",
"name":"NEW YORK"
},
{
"zipcrid":"10007C004",
"name":"NEW YORK"
},
{
"zipcrid":"10007C009",
"name":"NEW YORK"
},
{
"zipcrid":"10007C012",
"name":"NEW YORK"
},
{
"zipcrid":"10007C013",
"name":"NEW YORK"
},
{
"zipcrid":"10007C019",
"name":"NEW YORK"
},
{
"zipcrid":"10013C004",
"name":"NEW YORK"
},
{
"zipcrid":"10013C001",
"name":"NEW YORK"
},
{
"zipcrid":"10013C007",
"name":"NEW YORK"
},
{
"zipcrid":"10013C028",
"name":"NEW YORK"
},
{
"zipcrid":"10013C029",
"name":"NEW YORK"
},
{
"zipcrid":"10007C020",
"name":"NEW YORK"
},
{
"zipcrid":"10007C022",
"name":"NEW YORK"
},
{
"zipcrid":"10007C023",
"name":"NEW YORK"
},
{
"zipcrid":"10013C006",
"name":"NEW YORK"
},
{
"zipcrid":"10007C099",
"name":"NEW YORK"
},
{
"zipcrid":"10038C037",
"name":"NEW YORK"
},
{
"zipcrid":"10278C003",
"name":"NEW YORK"
},
{
"zipcrid":"10013C005",
"name":"NEW YORK"
},
{
"zipcrid":"10007C098",
"name":"NEW YORK"
},
{
"zipcrid":"10013C022",
"name":"NEW YORK"
},
{
"zipcrid":"10013C016",
"name":"NEW YORK"
},
{
"zipcrid":"10013C014",
"name":"NEW YORK"
},
{
"zipcrid":"10013C013",
"name":"NEW YORK"
},
{
"zipcrid":"10013C012",
"name":"NEW YORK"
},
{
"zipcrid":"10013C009",
"name":"NEW YORK"
},
{
"zipcrid":"10013C026",
"name":"NEW YORK"
},
{
"zipcrid":"10007C002",
"name":"NEW YORK"
},
{
"zipcrid":"10007C003",
"name":"NEW YORK"
},
{
"zipcrid":"10007C007",
"name":"NEW YORK"
},
{
"zipcrid":"10007C008",
"name":"NEW YORK"
},
{
"zipcrid":"10007C014",
"name":"NEW YORK"
},
{
"zipcrid":"10007C017",
"name":"NEW YORK"
},
{
"zipcrid":"10013C003",
"name":"NEW YORK"
},
{
"zipcrid":"10013C025",
"name":"NEW YORK"
},
{
"zipcrid":"10013C035",
"name":"NEW YORK"
},
{
"zipcrid":"10013C036",
"name":"NEW YORK"
},
{
"zipcrid":"10013C040",
"name":"NEW YORK"
}
]
]