Address Autocomplete Express - Precisely Data Integrity Suite

Data Integrity Suite APIs
Product
Data_Integrity
Spatial_Analytics
Data_Enrichment
geo_addressing_1
Services
Spatial Analytics
Data Enrichment
Geo Addressing
ft:title
Data Integrity Suite APIs
ft:locale
en-US
PublicationType
pt_developer
copyrightfirst
2023
copyrightlast
2026
Limited Availability: This API is currently available only to select users and might be subject to change before general availability.

The Address Autocomplete Express API Service searches a country dataset and returns a list of predicted address matches. If requested, the API can sort the list to provide location biased results. Addresses within the specified search radius are listed first, followed by other matches in the country dataset.

The Address Autocomplete Express API Service uses STANDARD match mode. It requires a close match and generates a moderate number of match candidates.

This method consumes credits.

Note: You can try out the Address Autocomplete Express API with a Free Trial Account.

HTTP Request:

  • URL Composition

    Base URL: https://api.cloud.precisely.com

    Address Autocomplete Express: /v1/express-autocomplete

  • Supported Methods: POST only
  • Rate Limit (Transactions per second): 120
  • Input Fields Each request to the API service requires parameters, which are listed below. All requests require a Bearer token that can be generated using your account's key-secret. To produce a bearer token for an API request, the generated key-secret combinations are used. The generated token is valid for 3600sec (1 hour), then it needs to be regenerated.

    The data should be encoded as a JSON array, where each element in the array is a JSON object with field names identical to those in the input and output fields listed below.

    Address Autocomplete Express sample request 
    {
    "preferences": {
        "maxResults": 5,
        "customPreferences": {
            "SEARCH_TYPE": "ADDRESS"
        },
        "originXY": [],
        "distance": {
            "value": 150,
            "distanceUnit": "METER"
        }
    },
    
    "address": {
        "addressLines": [
            "One global view"
        ],
        "country": "USA"
    }
}
    Table 1. Parameters
    Parameter Description
    preferences Options supported by Address Autocomplete Express.
    addresses List of addresses to be processed.

preferences Parameters

Below are the preferences for Address Autocomplete Express service. The only matchMode

Option Type Description 
customPreferences: {
    "SEARCH_TYPE": "ADDRESS"
 },

String

 Which Index to search.
  • ADDRESS (Default)
  • POI
  • AUTO
For AUTO:

  • If the first two characters are alphabetic (a–z), the input is treated as POI. If the second character is numeric (0–9), classification switches from POI to ADDRESS.

  • If the first character is numeric or a special character, the input is classified directly as ADDRESS.

 
distance : {
      "value": 5,
      "distanceUnit": "MILE"
}
 		distance (Optional) If you specify distance values, the response will first list prediction values that are within distance:value distance:distanceUnit from originXY. It will only return predictions that contain terms that exactly match terms in the request's addressLines. The response will then list prediction values outside the radius that span the whole country dataset.
  • value: The length of the search radius. The maximum allowed is 50 miles. The default is 5.
  • distanceUnit: The unit of measurement for value. Supported units are FOOT, METER, MILE, and KILOMETER. The default is MILE.
maxResults Integer

(Optional) The maximum number of candidates to return. This must be an integer value. The default is 10. The maximum allowed is 10.
originXY <Double> array XY coordinates of the origin address. 
{
"preferences" : 
  {
  "originXY" : [-73.70252500000001, 42.68323]
  }
}
X-Transaction-Id

(header)

 String

To efficiently manage a high volume of API calls and maintain organization, we group API calls for the same address into a single "transaction." A transaction is considered complete when one of the following conditions is met:

  • 15 seconds have passed
  • 12 API calls have been made

whichever happens first.

The Transaction ID (GUID) must be sent as part of the x-transaction-id header in each API request. We recommend users generate a new Transaction ID for every new transaction.

If the same Transaction ID is reused after a transaction is marked complete, our system will treat it as a new transaction while keeping the same ID.

Examples:

15-Second Scenario: A user starts typing an address and includes a Transaction ID (e.g., 1234-5678-ABCD) in the x-transaction-id header:
  • They make 4 calls (e.g., for "12", "123", "123 Main", "123 Main St") within 15 seconds.
  • After 15 seconds, the transaction is marked complete.
  • If the user's input is still not finished (e.g., they want to add "Apt 4") and they continue using the same Transaction ID (1234-5678-ABCD), our system will treat these additional calls as part of a new transaction.
12-Call Scenario: Another user types quickly and includes a Transaction ID (e.g., 5678-1234-EFGH) in the x-transaction-id header:
  • They make 12 calls (e.g., for "1", "12", "123", ..., "123 Main St Apt 4") within 3 seconds.
  • Since the 8-call limit is reached, the transaction is marked complete.
  • If the user continues to refine or add to their input using the same Transaction ID (5678-1234-EFGH), our system will treat these additional calls as part of a new transaction.
clientLocale String

Two‑letter language code (en, zh, etc.) used to request the output in a specific language for the selected country. If the requested language is not supported for that country, the service returns an error.
filterBias String

Specifies how the service should scope or prioritize results based on the provided filters. Two modes are supported:

  • filter — Hard include/exclude. Results must (or must not) match the specified values.

    Supported fields:postalCode, city (both include/exclude), poiCategory (POI + filter only)

  • bias — Soft ranking boost. Matching results are ranked higher, but non‑matching results may still appear.

    Supported fields: postalCode, city (include only; exclude not supported)

Use this parameter to control whether the service enforces strict filtering or applies preference‑based ranking.

address Parameters

Note: The only address options for the request are addressLines and country. All other address fields are not honored.

The following table lists the request parameters for the Address Autocomplete Express service:

Parameter Type Description
addressLines List Address to search for, based on the country's addressing standard.

Example single-line request:

"10 downing street london SW1A 2AA"
Example multi-line request: 
"10 DOWNING STREET",
"LONDON, SW1A 2AA"
country String Values are based on the ISO 3166-1 standard for country codes (returned in alpha-2, alpha-3, or numeric format).