Microburbs
Microburbs API
Open in the full API reference →
Property - Surroundings

Surrounding listing-history signals (200 m)

GET/v1/properties/{gnaf_id}/surroundings/listing-history-signals20¢ per call

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

Price: 20¢ per call.

Authorization

Request

The only values you send. Fields under Responses below are what comes back — you never pass those.

Path parameters

gnaf_idstringrequired

Query parameters

None — this endpoint accepts no query parameters. Call the path above with your bearer token and nothing else.

Responses

Successful Response

application/json
SurroundingListingSignalsfields returned to you
gnaf_pidstringalways returned

The subject property's GNAF PID.

radius_mintegeralways returned

Radius of the search box around the subject, metres.

recent_window_yearsintegeralways returned

Recency window used to derive the signals (years).

countintegeralways returned

Properties with any listing history (never-listed properties carry no signal and are omitted).

signalsarray of ListingHistorySignalalways returned

Per-property signals, sorted by GNAF PID.

summaryobjectalways returned

Counts of each signal across the returned properties.

GET/v1/properties/{gnaf_id}/surroundings/listing-history-signals
cURL
curl --request GET \
  --url 'https://api.microburbs.com.au/v1/properties/GANSW704074813/surroundings/listing-history-signals' \
  --header 'Authorization: Bearer test'
Example Responses
{
  "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
    }
  }
}
Successful Response200
application/json