Methods

Method detail for: getGeoListByCity

This request requires you to submit a city and two-letter State abbreviation. The API will return a list of IDs for all objects of the selected type within that city/state.

Valid Datasets

DatasetDataset DetailsMethod Parameters
Maponics College Campus BoundariesClick To ViewClick To View

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

  • city*
  • (Note: Items marked with * are required)

Carrier RoutesClick To ViewClick To View

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

Maponics Destination & Venue BoundariesClick 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:

Maponics +Residential BoundariesClick To ViewClick To View

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

Maponics Shopping BoundariesClick To ViewClick To View

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

  • city*
  • state
  • (Note: Items marked with * are required)

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>getGeoListByCity</method> <returnType>xml</returnType> <returnGeoType>wkt</returnGeoType> <parameters> <state>NY</state> <city>New York</city> </parameters> </request> </data>
{ "data":{ "auth":{ "loginname":"your_username", "key":"your_api_key" }, "request":[ { "dataset":"Z", "method":"getGeoListByCity", "returnType":"json", "parameters":{ "state":"NY", "city":"New York" } } ] } }
<?xml version="1.0" encoding="UTF-8" ?> <data> <resultcode>0</resultcode> <message>Return OK</message> <requestid>01-11328529</requestid> <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-14472", "request":[ [ { "zip":"12417" }, { "zip":"10024" }, { "zip":"11010" }...{ "zip":"13638" }, { "zip":"13664" }, { "zip":"13665" } ] ] } ]