Address Autocomplete Express Location Biased Results Example - 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.

You can request that the Address Autocomplete Express (Beta) API returns location biased results. If you specify the preferences parameter's distance values, the response will first list prediction values that are within distance:valuedistance: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.

distance:

  • 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.

Location Biased Example

Sample request body:

{
  "preferences": {
    "maxResults": 5,
    "distance": {
      "value": 5,
      "distanceUnit": "MILE"
    },
    "originXY": [-122.395932, 37.785626]
  },
  "address": {
    "addressLines": [
      "303"
    ],
    "country": "usa"
  }
}
The origin XY has been set to a location in San Francisco. The prediction values returned will be: 
"prediction1": "303 2nd St, San Francisco CA 94107"
"prediction2": "303 2nd St Ste 120D, San Francisco CA 94107"
"prediction3": "303 303, Nome AK 99762"
"prediction4": "303 303 P, Elko NV 89801"
"prediction5": "303 Fm 303, Sudan TX 79371"

prediction1 and prediction2 are coming from the given distance radius value and the rest of the prediction values are coming from the entire USA country dataset.

If more context is added to the request's addressLines, more accurate predictions are returned. 

{
  "preferences": {
    "maxResults": 5,
    "distance": {
      "value": 5,
      "distanceUnit": "MILE"
    },
    "originXY": [-122.395932, 37.785626]
  },
  "address": {
    "addressLines": [
      "303 2nd Ave ny"
    ],
    "country": "usa"
  }
}
The prediction values returned would be: 
"prediction1": "303 2nd Ave, New York NY 10003"
"prediction2": "303 2nd Ave, Frankfort NY 13340"
"prediction3": "303 2nd Ave, Albany NY 12209"
"prediction4": "303 2nd St, San Francisco CA 94107"
"prediction5": "303 2nd St Ste 500S, San Francisco CA 94107"

prediction1, prediction2, and prediction3 are from in New York, within 5 miles from originXY. The rest of the prediction values are outside the 5 mile radius.