Gross rental yield per microburb
/v1/suburbs/{suburb_name}/market/yield-map20¢ per callGross rental yield for every microburb (mesh block) in the suburb —
weekly rent x 52 over median price — with both inputs returned so the
number is checkable, plus the best- and worst-yielding pockets. 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_namestringrequiredExact 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
Responses
Successful Response
suburbstringalways returnedCanonical SAL name.
metricstringalways returnedAlways 'gross_rental_yield_house'.
unitstringalways returnedAlways 'percent' — note /market/yield-pct reports the same metric as a decimal.
as_ofstringmay be nullDate of the surfaces (YYYY-MM-DD).
definitionstringalways returnedHow the figure is derived.
n_microburbsintegeralways returnedMicroburbs with both a rent and a price.
microburbsarray of YieldMbalways returnedPer-microburb yields, highest first.
highestobjectmay be nullGross rental yield for one microburb, with both inputs.
lowestobjectmay be nullGross rental yield for one microburb, with both inputs.
/v1/suburbs/{suburb_name}/market/yield-mapcurl --request GET \
--url 'https://api.microburbs.com.au/v1/suburbs/Belmont%20North/market/yield-map' \
--header 'Authorization: Bearer test'{
"data": {
"suburb": "Belmont North",
"metric": "gross_rental_yield_house",
"unit": "percent",
"as_of": "2026-08-16",
"definition": "Gross rental yield for the mesh block: modelled median weekly house rent x 52, divided by the modelled median house price, as a percentage. Same definition as the suburb-wide yield at /market/yield-pct (which reports it as a decimal); gross, so before rates, strata, management or vacancy. Microburbs missing either the rent or the price are absent, not zero.",
"n_microburbs": 58,
"microburbs": [
{
"mb": "10439020000",
"street": "Floraville",
"gross_yield_pct": 6.65,
"weekly_rent": 1140,
"median_price": 892000
}
],
"highest": {
"mb": "10439020000",
"street": "Floraville",
"gross_yield_pct": 6.65,
"weekly_rent": 1140,
"median_price": 892000
},
"lowest": {
"mb": "10434330000",
"street": "Arlington",
"gross_yield_pct": 1.85,
"weekly_rent": 570,
"median_price": 1600000
}
}
}