Property Frontage

Detect the front-facing direction of a property from its address. Returns a compass bearing, confidence score, and a reference image showing the detected orientation.

Overview

The property frontage endpoint determines which direction a property faces from its address. It identifies visual cues like driveways, garages, and street-facing features to calculate a compass bearing (0-359 degrees) with a confidence score.

This is particularly useful as a preprocessing step before generating drone footage — knowing the property's front direction helps you choose the best camera direction for the flyover.

Workflow tip: Detect the property frontage first, then use the result to set the options.direction parameter on the drone footage endpoint for the most compelling aerial view.

Quick Example

Submit a property address to detect its front-facing direction:

curl -X POST \
  -H "X-API-Key: dome_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "address": "42 Harbour Road, Sydney NSW 2000"
  }' \
  https://api.dometech.com.au/v1/property-frontage/detect

Response (202):

{
  "data":  {
    "job_id":  "550e8400-e29b-41d4-a716-446655440000",
    "status":  "queued"
  },
  "meta":  {
    "request_id":  "req_abc123",
    "timestamp":  "2026-02-18T10:00:00.000Z",
    "mode":  "live"
  }
}

Step-by-Step

1. Submit the Detection Request

Send a POST request to /v1/property-frontage/detect with the property address. If you already know the coordinates, you can provide options.lat and options.lng to skip geocoding.

curl -X POST \
  -H "X-API-Key: dome_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "address": "42 Harbour Road, Sydney NSW 2000",
    "options": {
      "lat": -33.8688,
      "lng": 151.2093
    }
  }' \
  https://api.dometech.com.au/v1/property-frontage/detect

The API returns a 202 Accepted response with a job_id. The analysis runs asynchronously.

2. Poll for Completion

Poll the job status endpoint until the status changes to completed. Frontage detection typically completes within 15 to 30 seconds.

curl -H "X-API-Key: dome_live_your_key_here" \
  https://api.dometech.com.au/v1/jobs/550e8400-e29b-41d4-a716-446655440000

3. Retrieve the Result

When the job completes, the output field contains the detected direction, confidence score, reasoning, and a demo image.

{
  "data":  {
    "id":  "550e8400-e29b-41d4-a716-446655440000",
    "job_type":  "property_frontage",
    "status":  "completed",
    "mode":  "live",
    "input":  { "address":  "42 Harbour Road, Sydney NSW 2000" },
    "output":  {
      "direction":  135,
      "direction_label":  "Southeast",
      "confidence":  0.92,
      "reasoning":  "The driveway and garage opening face southeast toward the street",
      "demo_image_url":  "https://storage.example.com/frontage_demo.jpg"
    },
    "created_at":  "2026-02-18T10:00:00.000Z",
    "updated_at":  "2026-02-18T10:00:20.000Z",
    "completed_at":  "2026-02-18T10:00:20.000Z"
  },
  "meta":  {
    "request_id":  "req_abc123",
    "timestamp":  "2026-02-18T10:00:20.000Z",
    "mode":  "live"
  }
}

4. Regenerate at Adjusted Direction (Optional)

If the auto-detected direction needs adjustment, you can regenerate the demo image at a manually specified bearing using the /v1/property-frontage/regenerate endpoint.

curl -X POST \
  -H "X-API-Key: dome_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "address": "42 Harbour Road, Sydney NSW 2000",
    "direction": 187,
    "options": {
      "lat": -33.8688,
      "lng": 151.2093
    }
  }' \
  https://api.dometech.com.au/v1/property-frontage/regenerate

Completed output:

{
  "direction":  187,
  "direction_label":  "South",
  "demo_image_url":  "https://storage.example.com/frontage_demo_187.jpg"
}

Options

Detection endpoint parameters:

ParameterTypeRequiredDescription
addressstringYesFull property address
options.latnumberNoLatitude override (skips geocoding if both lat/lng provided)
options.lngnumberNoLongitude override (skips geocoding if both lat/lng provided)
webhook_urlstring (URI)NoURL to receive progress and completion webhooks
callback_metadataobjectNoOpaque data returned in webhook payloads

Regeneration endpoint additional parameters:

ParameterTypeRequiredDescription
addressstringYesFull property address
directionintegerYesCompass bearing of the property front (0-359 degrees)
options.property_center_latnumberNoOverride latitude for screenshot center (fine-tune positioning)
options.property_center_lngnumberNoOverride longitude for screenshot center (fine-tune positioning)

See the API Reference for full parameter details and response schemas.

Output

When the detection job completes, the output object contains:

FieldTypeDescription
directionintegerCompass bearing in degrees (0-359, where 0 = North)
direction_labelstringHuman-readable direction label (e.g. "Southeast", "North")
confidencenumberConfidence score from 0 to 1
reasoningstringAI explanation of why this direction was chosen
demo_image_urlstringURL of the demo image showing the detected front direction

Next Steps