Specifies search preferences for Address Proximity Search operations, including the dataset to search, maximum results, search radius, and custom preferences for processing modes.
Schema Overview
The Address Proximity Search Preferences schema defines search configuration options for Address Proximity Search requests. The dataset field is required; all other fields are optional.
Preference Fields
| Field | Type | Required | Description |
|---|---|---|---|
| dataset | string | Yes | The dataset to search against (for example, address-fabric-usa). This field is required. |
| maxResults | integer | No | The maximum number of candidates to return. If not specified, the API returns a default number of results. |
| distance | object | No | Specifies the search radius distance and unit. See Distance schema. If not specified, a default search radius is used. |
| customPreferences | object | No | Custom preferences for controlling additional functionality. CLOSEST (true/false). |
Custom preferences
The customPreferences object supports the following keys:
- CLOSEST: When set to true, returns only the closest matching address. Default is false.
Example Address Proximity Search Preferences
{
"dataset": "address-fabric-usa",
"maxResults": 5,
"distance": {
"value": 2.0,
"distanceUnit": "MILE"
},
"customPreferences": {
"CLOSEST": "false"
}
}