Microburbs
Live sandbox. Send any request below against one sample suburb and property — no signup needed. For full coverage, create an API key.
Classic docs
Microburbs Property Data API
Suburb - Market

Negative gearing by mesh block (by suburb)

GET/v1/suburbs/{suburb_name}/market/negative-gearing-map20¢ per call

Share of each microburb's investment properties that are negatively geared (our estimate, 0-100), with how many properties it is taken over. Values only; polygons come from /shapes/mesh-blocks.

Exact suburb identifier required. Exact ABS Suburb and Locality (SAL) name, e.g. Burwood (NSW) — many suburbs carry a state suffix. If starting from free text or an unverified bare name, first call GET /v1/geocode/suburb?q=<text>, then use the exact data[].area_name it returns. Suburb data endpoints do not guess a state or typo-correct names.

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

suburb_namestringrequired

Exact ABS Suburb and Locality (SAL) name, e.g. `Burwood (NSW)` — many suburbs carry a state suffix. If starting from free text or an unverified bare name, first call `GET /v1/geocode/suburb?q=<text>`, then use the exact `data[].area_name` it returns. Suburb data endpoints do not guess a state or typo-correct names.

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
SuburbNegativeGearingMapfields returned to you
suburbstringalways returned

Canonical SAL name.

metricstringalways returned

Always 'negatively_geared_share'.

unitstringalways returned

Always 'percent'.

definitionstringalways returned

How the figure is derived.

n_microburbsintegeralways returned

Microburbs with an estimate.

microburbsarray of NegativeGearingMbalways returned

Per-microburb shares, by mesh-block code.

GET/v1/suburbs/{suburb_name}/market/negative-gearing-map
cURL
curl --request GET \
  --url 'https://api.microburbs.com.au/v1/suburbs/Belmont%20North/market/negative-gearing-map' \
  --header 'Authorization: Bearer test'
Example Responses
{
  "data": {
    "suburb": "Belmont North",
    "metric": "negatively_geared_share",
    "unit": "percent",
    "definition": "Share of the mesh block's likely investment properties that are negatively geared — rent below the cost of holding the property — as our estimate, percent 0-100. `n_scored` is how many investment properties on the block the share is taken over; read small blocks with care.",
    "n_microburbs": 62,
    "microburbs": [
      {
        "mb": "10431160000",
        "street": "Floraville",
        "neg_geared_pct": 55.6,
        "n_scored": 18
      }
    ]
  }
}
Successful Response200
application/json