Methods

Method detail for: getGeoAttByArea

This request requires you to submit uniquely identifying characteristics for an object within a specific (primary) dataset, and a target (secondary) dataset. the API will spatially determine the list of objects within the secondary dataset that are wholly or partially within the uniquely identified object from the primary dataset, 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

DatasetDataset DetailsMethod Parameters
CountiesClick To ViewClick To View

When calling this dataset using this method, use these parameters:

Maponics Neighborhood Boundaries North AmericaClick To ViewClick To View

When calling this dataset using this method, use these parameters:

Census PlacesClick To ViewClick To View

When calling this dataset using this method, use these parameters:

Maponics +Residential BoundariesClick To ViewClick To View

When calling this dataset using this method, use these parameters:

ZIP CodesClick To ViewClick To View

When calling this dataset using this method, use these parameters:

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>getGeoAttByArea</method> <parameters> <targetAreaType>N</targetAreaType> <name>60610</name> <city></city> <state></state> <submatch>N</submatch> <searchType>INTERSECT</searchType> <fields>neighborhd,nbr_type</fields> </parameters> </request> </data>
{ "data":{ "auth":{ "loginname":"your_username", "key":"your_api_key" } }, "request":[ { "dataset":"C", "method":"getGeoAttByArea", "count":"false", "returnType":"json", "parameters":{ "targetAreaType":"Z", "name":"Autauga", "city":"", "state":"AL", "submatch":"", "searchType":"INTERSECT", "fields":"zip" } } ] }
<?xml version="1.0" encoding="UTF-8" ?> <data> <resultcode>0</resultcode> <message>Return OK</message> <requestid>1858</requestid> <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-2194", "request":[ [ { "zip":"10006" }, { "zip":"10007" }, { "zip":"10013" }, { "zip":"10036" }, { "zip":"10279" }, { "zip":"10281" }, { "zip":"10282" } ] ] } ]