Gross rental yield — full series
/v1/suburbs/{suburb_name}/market/yield-pct-series20¢ per callFull gross-rental-yield history by property type, decimal fractions.
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
area_namestringalways returnedSuburb (SAL) name.
area_levelstringalways returnedAlways 'suburb' for these endpoints.
housearray of SeriesPointmay be nullHouse gross-yield series — DECIMAL fractions (0.0347 = 3.47%).
unitarray of SeriesPointmay be nullUnit gross-yield series — DECIMAL fractions.
as_ofstringmay be nullDate of the most recent observation (YYYY-MM-DD).
/v1/suburbs/{suburb_name}/market/yield-pct-seriescurl --request GET \
--url 'https://api.microburbs.com.au/v1/suburbs/Belmont%20North/market/yield-pct-series' \
--header 'Authorization: Bearer test'{
"data": {
"area_level": "suburb",
"area_name": "Belmont North",
"as_of": "2026-08-09",
"house": [
{
"date": "2015-01-31",
"value": 0.0432
},
{
"date": "2026-08-09",
"value": 0.0347
}
],
"unit": [
{
"date": "2015-01-31",
"value": 0.0501
},
{
"date": "2026-03-08",
"value": 0.0389
}
]
}
}