Lookup Postal Codes

Use Lookup Postal Codes endpoint to lookup postal codes closest to the input coordinates.

Operations

Lookup a postal code from geo location

Request

Send a GET request to lookup a postal code from geo location.

Query

tstring

Transmission Reference - Serves as a unique identifier for this set of records.

Example:t=Test

idany, (password)required

Required. The License Key issued by Melissa.

Example:id={REPLACE-WITH-YOUR-LICENSE-KEY}

latstringrequired

Required. The latitude geographic coordinate in decimal format.

Example:lat=33.63756710910554

longstringrequired

Required. The longitude geographic coordinate in decimal format.

Example:long=-117.60695049134513

distnumber, <= 10

Maximum Distance - The requested maximum distance in miles.

Default:10

Example:dist=10

recsnumber, <= 100

Maximum Records - The requested number of records.

Default:100

optstring

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.

Enum:"Level:CarrierRoute""Level:Plus4""Level:PostalCode"

formatstring

The desired format of the response.

Default:"xml"

Enum:"json""xml"

Example:format=json

Headers

Acceptstringrequired

Format of the response.

Enum:"application/json""application/xml""*/*"

Example:*/*

Content-Typestringrequired

Format of the request.

Enum:"application/json""application/xml"

curl -i -X GET \
  'https://reversegeo.melissadata.net/v3/web/ReverseGeoCode/doLookupPostalCodes?id=%7BREPLACE-WITH-YOUR-LICENSE-KEY%7D&lat=33.63756710910554&long=-117.60695049134513' \
  -H 'Accept: */*' \
  -H 'Content-Type: application/json'

Responses

Successful response

Body

Versionstring

The current service version number.

TransmissionReferencestring

A pass-through of the input TransmissionReference field.

TransmissionResultsstring

Lists error codes from any errors caused by the most recent request as a whole. For more information, see Reverse GeoCoder Result Codes.

Resultsstring

Comma delimited status, error codes, and change codes for the record. For more information, see Reverse GeoCoder Result Codes.

TotalRecordsinteger

Total number of records.

RecordsArray of objects, [ 1 .. 100 ] items

Response

{
  "Version": "6.2.0.5179",
  "TransmissionReference": "",
  "TransmissionResults": "",
  "Results": "GS07",
  "TotalRecords": 1,
  "Records": [
    { … }
  ]
}