Count matching suburbs
/v1/suburbs/finder/count5¢ per callHow many suburbs match the filter, without paying per row. 5c.
Use this to size a result before searching: /search is capped at 25 rows
per call, so total here tells you how many offset pages you need.
Price: 5¢ per call.
Authorization
Request
The only values you send. Fields under Responses below are what comes back — you never pass those.
Query parameters
filterarrayoptionalRange filter `fieldKey:min..max` (repeatable). Valid fieldKeys: medianHousePrice, grossYield, medianRent, growthForecast4yr, growth10yrCagr, growth3yrCagr, rentGrowth3yr, soldAtLossPct, daysOnMarket, vacancyRate, unitMedianPrice, unitGrossYield, unitMedianRent, unitGrowthForecast4yr, unitGrowth10yrCagr, unitGrowth3yrCagr, unitRentGrowth3yr, unitSoldAtLossPct, unitDaysOnMarket, unitVacancyRate, stockOnMarket, monthsOfInventory, landValuePerSqm, lifestyleScore, safetyScore, hipScore, affluenceScore, renters, distanceCbdKm, publicHousingPct, overseasBornPct, welfareReliancePct, unemploymentPct, singleParentsPct, familyHouseholdsPct, privateSchoolPct, medianIncomeWeekly, communityDepthIndex, premiumRenovationIndex, homeOfficeIndex, tranquilityIndex, innovationEconomyIndex, alternativeLivingIndex, investorConcentration, negativeGearingExposure, mortgageStress. Apartment/unit metrics are the `unit`-prefixed keys (unitMedianPrice, unitGrossYield, unitMedianRent, …); the unprefixed market keys are houses. Unit data only exists where a suburb has a real unit market — coverage runs ~13-54% of suburbs depending on the field, so a unit filter implicitly excludes house-only suburbs.
statesstringoptionalComma-separated states (names or abbreviations), e.g. `VIC`.
regionsstringoptionalComma-separated EXACT SA4 region names — call GET /v1/suburbs/finder/regions for the list. A metro name like `Melbourne` alone will NOT match.
property_typestringoptionalLegacy flag: 'unit' re-points the ten unprefixed house-market keys (medianHousePrice, grossYield, ...) at their unit column. It does NOT affect the explicit `unit`-prefixed keys, which are always units. Prefer the `unit` keys — they are visible in /fields and can be mixed with house keys in one query.
Responses
Successful Response
totalintegeralways returnedSuburbs matching every range filter (after the hard exclusions).
/v1/suburbs/finder/countcurl --request GET \
--url 'https://api.microburbs.com.au/v1/suburbs/finder/count' \
--header 'Authorization: Bearer test'{
"data": {
"total": 126
}
}