v1
latestOpenAPI 3.1.22026-08-065935.5 KBLookup Postal Codes
Lookup a postal code from geo location
Send a GET request to lookup a postal code from geo location.
get/doLookupPostalCodes
Query parameters
tstring
Transmission Reference - Serves as a unique identifier for this set of records.
{"stackTrail":"components:parameters:LicenseKeyParam:schema","oasType":"schema","type":"unknown"}
Required. The License Key issued by Melissa.
latstring required
Required. The latitude geographic coordinate in decimal format.
longstring required
Required. The longitude geographic coordinate in decimal format.
distnumber
Maximum Distance - The requested maximum distance in miles.
recsnumber
Maximum Records - The requested number of records.
opt'Level:CarrierRoute' | 'Level:Plus4' | 'Level:PostalCode'
Options - Specify which options to use for the selected action. List of options in <OptionName>:<Parameter> format. Multiple options are delimited with a ,.
For example: OptionName:Parameter,OptionName:Parameter.
- Level:< CarrierRoute | Plus4 | PostalCode > - This option specifies the level of data to search. Depending on which parameter you set for Level, you can return the ZIP, ZIP+4, or ZIP and Carrier Route with your records.
- CarrierRoute - Two fields are returned for each record:
- PostalCode: A 5-digit postal code
- CarrierRoute: the nearest Carrier Route.
- Plus4 - Two fields are returned for each record:
- PostalCode: a 9-digit ZIP+4 Postal Code.
- CarrierRoute: the nearest Carrier Route.
- PostalCode - Default. Returns the nearest 5-digit Postal Code.
- CarrierRoute - Two fields are returned for each record:
format'json' | 'xml'
The desired format of the response.
Headers
Accept'application/json' | 'application/xml' | '*/*' required
Format of the response.
Content-Type'application/json' | 'application/xml' required
Format of the request.
Response
Successful response