The request body for Address Proximity Search operations. Contains location details and search preferences to find addresses near a geographic point.
Address Proximity Search Request Fields
The Address Proximity Search Request schema defines the structure of request payloads for Address Proximity Search operations. All requests must include both location and preferences objects.
Request Fields
| Field | Type | Required | Description |
|---|---|---|---|
| preferences | object | Yes | Search preferences including dataset, maxResults, distance, and customPreferences. See Address Proximity Search Preferences schema. |
| location | object | Yes | Location details containing latitude, longitude, country, and optional addressId. See Address Proximity Search Location Detail schema. |
Example Address Proximity Search Request
{
"preferences": {
"dataset": "address-fabric-usa",
"maxResults": 1,
"distance": {
"value": 1.0,
"distanceUnit": "MILE"
},
"customPreferences": {}
},
"location": {
"addressId": "1",
"latitude": 37.718356,
"longitude": -122.392016,
"country": "USA"
}
}