zipToGeo API

This API is used to obtain a list of geo values from a postal code.

Command

"livealert/zipToGeo/1"



Inputs

The following values are expected in the JSON body:

Name Type Required Description
zip String

The postal code you would like to receive our geographic indexes for.(must not include spaces)
countryCode String

A 2 character country code where the postal code is located. Valid country codes are: US, MX, JP, IT, GB, FR, ES, DE, CA, BR, AU.


Example Command

{ 
	"command" : "livealert/zipToGeo/1" ,
	"zip" : "98133" , 
	"countryCode" : "US"
}

Example Response

{
	"command": "livealert/zipToGeo/1",
	"response": {
		"Region (US)": 4,
		"Division (US)": 9,
		"DMA (US)": 172,
		"MSA (US)": 233,
		"CSA (US)": 146,
		"CBSA (US)": 763,
		"State (US)": 63,
		"County (US)": 2965
	},
	"result": 0
}