Service Agreement
Privacy Statement
ZipCode Lookup web service features several functions for US zipcodes and distance manipulations: zip code lookup by distance, zip code coordinates, distance between zip codes.
NOTE: This service requires a subscription.
You can register online using Subscriptions
interface.
There're several types of subscriptions available including a free subscription
so you can continue using the web service without paying. When you subscribe
you will be issued a subscriber ID that uniquely identify you. You must submit
that ID with every request by setting AuthenticationHeader SOAP header.
Consult WSDL for more information.
The following operations are supported. For a formal definition, please review the Service Description.
-
GetAllUserPlaces
Returns an array of all user-defined places. -
GetUserPlacesWithin
Returns a list of user-defined places within a specified distance from a given place. Parameters: zip - 5 digit zip code or Canadian postal code (M3H, M3H 6A7), state - 2 letter state code (not required for zip codes), distance - distance in miles, category - an optional category, if not empy only user-defined places that match the category will be returned. -
GetZipCodesWithin
Returns a list of zip codes within a specified distance from a given zip code. Parameters: zip - 5 digit US zip code or Canadian postal code (M3H, M3H 6A7), distance - distance in miles. -
GetZipCodesWithinFiltered
Returns a list of zip codes within a specified distance from a given zip code. Parameters: zip - 5 digit zip code or Canadian postal code (M3H, M3H 6A7), distance - distance in miles, filter - string to filter results, filterType - type of filter (StartsWith, EndsWith, Anywhere, None). -
GetDistanceBetweenZipCodes
Returns a distance in miles between two zip codes. Parameters: zip1 - 5 digit zip code or Canadian postal code (M3H, M3H 6A7), zip2 - 5 digit zip code or Canadian postal code (M3H, M3H 6A7). -
GetThreeDigitZipCodesWithin
Returns a list of zip codes within a specified distance from a given zip code. Parameters: zip - 5 digit zip code or Canadian postal code (M3H, M3H 6A7), distance - distance in miles. -
GetPlacesInside
Returns a list of geo places inside a given zip code. Parameters: zip - 5 digit zip code or Canadian postal code (M3H, M3H 6A7), state - 2 letter state code (not required for zip codes). -
GetZipCodeCoordinates
Returns a centroid point of the zip code in both radians and degrees. Parameters: zip - 5 digit zip code or Canadian postal code (M3H, M3H 6A7). -
SaveUserPlaces
Saves user-defined places.
