Microburbs
Microburbs API
Open in the full API reference →
Suburb - Lifestyle

Amenity price impacts

GET/v1/suburbs/{suburb_name}/lifestyle/poi-impacts10¢ per call

What the absence of petrol stations, fast food and bottle shops near sold properties was worth.

Price: 10¢ per call.

Authorization

Request

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

Path parameters

suburb_namestringrequired

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
LifestylePoiImpactsfields returned to you
area_namestringalways returned

Suburb (SAL) name.

area_levelstringalways returned

Always 'suburb' for these endpoints.

n_salesintegeralways returned

Recent sales in the analysis window.

median_priceintegeralways returned

Median sale price across those sales (AUD).

total_premiumintegeralways returned

Combined absence premium across all drivers (AUD).

driversarray of PoiImpactDriveralways returned

Drivers, largest premium first.

GET/v1/suburbs/{suburb_name}/lifestyle/poi-impacts
cURL
curl --request GET \
  --url 'https://api.microburbs.com.au/v1/suburbs/Belmont%20North/lifestyle/poi-impacts' \
  --header 'Authorization: Bearer test'
Example Responses
{
  "data": {
    "area_level": "suburb",
    "area_name": "Castlecrag",
    "drivers": [
      {
        "coverage_pct": 100,
        "detail": "100% of 9 recent sales in Castlecrag were at properties with no petrol station nearby. Those sales cleared about $184,500 more than comparable suburbs with petrol stations, equivalent to 4.1% of the $4,500,000 median price here.",
        "label": "No petrol station nearby",
        "pct_of_median": 4.1,
        "premium_dollars": 184500
      }
    ],
    "median_price": 4500000,
    "n_sales": 9,
    "total_premium": 263000
  }
}
Successful Response200
application/json