Property Frontage
Detect and adjust property front-facing direction
POST
/v1/property-frontage/detect202Detect the front-facing direction of a property from its address. Returns compass bearing, direction label, and a reference image.
Request Body
| Parameter | Type | Required | Description |
|---|---|---|---|
address | string | Yes | Full Australian property address |
options.lat | number | No | Pre-resolved latitude — skips geocoding when provided with lng |
options.lng | number | No | Pre-resolved longitude — skips geocoding when provided with lat |
webhook_url | string (URI) | No | URL to receive progress and completion webhooks |
callback_metadata | object | No | Opaque data returned in webhook payloads |
Request Example
{
"address": "example",
"options": {
"lat": 0,
"lng": 0
},
"webhook_url": "https://example.com/image.jpg"
}Response
{
"data": {
"job_id": "550e8400-e29b-41d4-a716-446655440000",
"status": "queued"
},
"meta": {
"request_id": "req_abc123",
"timestamp": "2026-03-12T10:00:00.000Z",
"mode": "live"
}
}POST
/v1/property-frontage/jobs/{jobId}/edit202Edit a completed frontage detection. Requires a direction in the body; creates an edit job that regenerates the frontage demo at the new angle.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
jobId | string | Yes |
Request Body
| Parameter | Type | Required | Description |
|---|---|---|---|
direction | integer (0-359) | Yes | Adjusted compass bearing of the property front (0-359 degrees). |
center_lat | number | No | Adjusted latitude for property center |
center_lng | number | No | Adjusted longitude for property center |
webhook_url | string (URI) | No | URL to receive progress and completion webhooks |
callback_metadata | object | No | Opaque data returned in webhook payloads |
Request Example
{
"direction": 0,
"webhook_url": "https://example.com/image.jpg"
}Response
{
"data": {
"job_id": "550e8400-e29b-41d4-a716-446655440000",
"status": "queued"
},
"meta": {
"request_id": "req_abc123",
"timestamp": "2026-03-12T10:00:00.000Z",
"mode": "live"
}
}On this page