Property - Surroundings

Surrounding listing-history signals (200 m)

Latest sold/rent dates and likely-owner-status signal per nearby property.

Price: 20¢ per call.

get/v1/properties/{gnaf_id}/surroundings/listing-history-signals

Request

  • Base URL: https://api.microburbs.com.au
  • URL: https://api.microburbs.com.au/v1/properties/{gnaf_id}/surroundings/listing-history-signals
  • Auth: HTTP bearer

Path parameters

gnaf_idstring required
Example:GANSW704074813

Response

Successful Response

availableboolean nullable

false on no-data responses. Omitted on success — branch on data !== null if you want a single discriminator.

reasonstring nullable

Machine-readable slug naming the no-data condition (e.g. no_avm_for_GANSW704074813). Stable per endpoint. Omitted on success.

messagestring nullable

Human-readable explanation. Omitted on success.

Example response

{
  "data": {
    "count": 97,
    "gnaf_pid": "GANSW704360755",
    "radius_m": 200,
    "recent_window_years": 10,
    "signals": [
      {
        "gnaf_pid": "GANSW704349559",
        "last_sold_date": "2021-11-23",
        "last_sold_years_ago": 4.6,
        "signal": "previously_for_sale"
      },
      {
        "gnaf_pid": "GANSW704341221",
        "last_sold_date": "2015-01-27",
        "last_sold_years_ago": 11.4,
        "signal": "no_recent_listings"
      }
    ],
    "summary": {
      "no_recent_listings": 24,
      "previously_for_sale": 55,
      "previously_rented": 18
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.