⌘K
GET /orders/:id
Returns a single order by its ID.
Base URL: https://api.geocerta.io
Sandbox URL: https://api-staging.geocerta.io
Authentication required. Include your API key in the
api-keyheader. See Authentication.
Endpoint
GET /orders/:id
Path Parameters
| Parameter | Type | Description |
|---|---|---|
id | string | The order ID. |
Response
200 OK — returns the order object.
Site fields
| Field | Type | Description |
|---|---|---|
site.is_valid | boolean | Whether the submitted geometry parsed successfully. |
site.address | string | The site address as supplied. |
site.wkt | string | Site geometry as WKT in British National Grid (EPSG:27700). |
site.area | number | Site area in square metres. 0 for points. |
site.x | number | Centroid Easting (British National Grid). |
site.y | number | Centroid Northing (British National Grid). |
site.centroid | GeoJSON Point | Centroid in WGS84 ([longitude, latitude]). |
site.geometry | GeoJSON geometry | Site geometry in WGS84. |
site.urban_type | string | Urbanisation classification (e.g. urban, rural). |
Errors
| Status | Message | Cause |
|---|---|---|
401 | Unauthorized | Missing or invalid API key |
403 | Forbidden | Order belongs to a different account |
404 | Not Found | No order exists with the given ID |
Example
curl "https://api.geocerta.io/orders/66f3a1b2c4e5d8f9a1b2c4e5" \
-H "api-key: YOUR_API_KEY"