v1

latestOpenAPI 3.1.22026-08-065935.5 KB
Lookup Addresses

Lookup addresses from geo location

Send a GET request to lookup addresses from geo location.

get/doLookup

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.

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.

  • IncludeApartments:< On | Off > - This option allows you to include records with a non-null baseMAK. Default of Off will not include non-null baseMAK records.
  • IncludeEmptyLots:< On | Off > - This option allows you to specify if you want to include addresses that are empty lots in your search. Default of Off will not include empty lots.
  • IncludeUndeliverable:< On | Off > - This option allows you to specify if you want to include addresses we have identified as unable to deliver mail to. Default of On will include undeliverable addresses.
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

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.