v1

latestOpenAPI 3.1.22026-08-0661077.2 KB

Address Autocompletion

Global Express Thoroughfare

GlobalExpressThoroughfare is a means for retrieving the thoroughfares within a Postal Code using the Postal Code and beginning of the thoroughfare name as the inputs.

The service requires at least one of the follwing input combinations:

Set A - thoroughfare

Set B - postalcode

get/GlobalExpressThoroughfare

Query parameters

diacriticreplacetrue | false

True replaces diacritics in the address. False will keep current diacritics in the address results. If left blank, this defaults to False.

format'xml' | 'json' | 'jsonp'

Desired format of the response. Possible values are json, jsonp, or xml, depending on the endpoint.

Note: the base URL for JavaScript format request is https://expressentry.melissadata.net/jsonp/.

idstring password required

Required. The License Key issued by Melissa.

maxrecordsnumber

The maximum number of records to return.

countrystring required

Required. The ISO2Code or country name of the address.

postalcodestring

Postal Code, ZIP. The complete postal code.

thoroughfarestring

Street, Thoroughfare. This is used to limit the search to thoroughfares beginning with the specified letters. This requires a minimum of three characters. For example, mai will return all thoroughfares beginning with mai in the specified postal code.

Headers

Accept'application/json' | 'application/javascript' | '*/*' required

Format of the response.

Content-Type'application/json' | 'application/xml' | 'application/javascript' | '*/*' required

Example:*/*

Format of the request.

Response

Global Express Locality Administrative Area response

Versionstring

The current service version number.

ResultCodestring

Lists result codes for the most recent request. For more information, see Global Express Entry Result Codes.

ErrorStringstring

Lists error codes from any errors caused by the most recent request. For more information, see Global Express Entry Result Codes.