Geospatial
In all Locations API requests, a geospatial filter {Location} to identify a location is required.
Geospatial filtering can be achieved using one of the three different Query Parameter sets described below.
Area
| Name | Description | Type | Examples |
|---|---|---|---|
| *country | Filter by country. | string | Administrative Areas |
| ⊢state | Filter by state. | string | Administrative Areas |
| ⊢ county | Filter by county. | string | Administrative Areas |
| ⊢ city | Filter by city. | string | Administrative Areas |
| ⊢suburb | Filter by suburb. | string | Administrative Areas |
GeometryID
| Name | Description | Type | Examples |
|---|---|---|---|
| *geometry_id | Filter by a previously saved geometry. | string | 379c730942e570d586a5520770c0a65d 4442852e86f5ef4cf241a43bac90a6dcfh |
Supported values for {geometry_id}
Value obtainable from $.id field of Create Geometry Response Body.
Circle
| Name | Description | Type | Examples | Default |
|---|---|---|---|---|
| *lat | Latitude of the circle center. | decimal | 43.770366014832014 | |
| *lng | Longitude of the circle center. | decimal | 11.257818620617464 | |
| *radius | Circle radius length. | decimal | 40 | |
| unit | Unit of measure for radius. Possible values are:km: kilometersm: metersmi: miles |
decimal | km m mi |
km |