Specifies the geographic location from which to start an Address Proximity Search, including latitude, longitude, country, and optional address identifier.
Schema Overview
The Address Proximity Search Location Detail schema defines the geographic location for Address Proximity Search requests. Latitude and longitude are required; country is required to identify the geographic region; addressId is optional for request correlation.
Location Fields
| Field | Type | Required | Description |
|---|---|---|---|
| latitude | number | Yes | Latitude coordinate (y-axis) in decimal degrees. Valid range is -90 to 90. |
| longitude | number | Yes | Longitude coordinate (x-axis) in decimal degrees. Valid range is -180 to 180. |
| country | string | Yes | Country name in ISO 3166-1 Alpha-2 or Alpha-3 format, or a common country name (for example, USA, US, UNITED STATES). This field is required to identify the geographic region. |
| addressId | string | No | Optional address identifier for the request. Used for correlation and tracking in responses. Maximum length is typically 255 characters. |
Coordinate system
Coordinates use the WGS 84 (EPSG:4326) coordinate reference system, which is the standard for geographic coordinates worldwide. Latitude values range from -90 (South Pole) to 90 (North Pole). Longitude values range from -180 (International Date Line West) to 180 (International Date Line East).
Example Address Proximity Search Location
{
"addressId": "1",
"latitude": 37.718356,
"longitude": -122.392016,
"country": "USA"
}