Parcels (V2)
Retrieves parcel and footprints data based on batches of U.S. location inputs. The data extraction is parcel based, meaning it retrieves data on all the buildings within the parcel at the requested location.
POST https://us-api.geox.ai/v2/parcels
Request Overview
- Batch Support: Process up to 500 locations in a single batch.
- Tracking: For each requested location, you can provide an
input_idfor tracking results. This field can be left empty if not needed. - Geocoding Confidence: V2 provides a
geocoding_confidencescore per parcel.
Request Body
| Name | Type | Description |
|---|---|---|
locations | array[Location] | Required. List of up to 500 location objects. |
Location Object
| Field | Type | Description |
|---|---|---|
input_id | string | Optional tracking ID for the location. |
address | string | Address in free text format. |
coordinates | object | Lat/Lng object: {"lat": float, "lng": float}. |
Response Schema
The response includes batch processing metadata and a list of results. Each result item contains tracking information and the parcel/footprints data.
{
"meta": { ...Meta Object },
"data": [
{
"input_id": "string",
"parcel_id": "string",
"parcel": { ...Parcel Object },
"footprints": [{ ...Footprint Object }]
}
]
}Example Usage
Example Request
- cURL
- JavaScript
- Python
curl -X POST "https://us-api.geox.ai/v2/parcels" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"locations": [
{
"input_id": "req_1",
"address": "1600 Amphitheatre Parkway, Mountain View, CA"
}
]
}'
fetch('https://us-api.geox.ai/v2/parcels', {
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_TOKEN',
'Content-Type': 'application/json'
},
body: JSON.stringify({
locations: [
{ input_id: 'req_1', address: '1600 Amphitheatre Parkway, Mountain View, CA' }
]
})
})
.then(response => response.json())
.then(data => console.log(data));
import requests
url = "https://us-api.geox.ai/v2/parcels"
payload = {
"locations": [
{"input_id": "req_1", "address": "1600 Amphitheatre Parkway, Mountain View, CA"}
]
}
headers = {
"Authorization": "Bearer YOUR_TOKEN",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())