Lookup postal codes from geo location

Request

Send a bulk request to lookup postal codes from geo location.

Headers

Acceptstringrequired

Format of the response.

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

Example:*/*

Content-Typestringrequired

Format of the request.

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

Body

required

CustomerIdstringrequired

Required. The License Key issued by Melissa.

Latitudestringrequired

Required. The latitude geographic coordinate in decimal format.

Longitudestringrequired

Required. The longitude geographic coordinate in decimal format.

MaxDistancestring

The requested maximum distance in miles. The maximum value is 10. Default is 10.

MaxRecordsstring

The requested number of records. The maximum value is 100. Default is 100.

Optionsstring

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.

TransmissionReferencestring

Serves as a unique request identifier.

curl -i -X POST \
  https://reversegeo.melissadata.net/v3/web/ReverseGeoCode/doLookupPostalCodes \
  -H 'Accept: */*' \
  -H 'Content-Type: application/json' \
  -d '{
    "CustomerId": "{REPLACE-WITH-YOUR-LICENSE-KEY}",
    "Latitude": "33.63756710910554",
    "Longitude": "-117.60695049134513",
    "MaxDistance": "10",
    "MaxRecords": "",
    "Options": "",
    "TransmissionReference": "Test"
  }'

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": [
    { … }
  ]
}