Suburb - Finder

Count matching suburbs

GET/v1/suburbs/finder/count5¢ per call

How many suburbs match the filter, without paying per row. 5c.

Price: 5¢ per call.

Authorization

Bearer tokentest

Sandbox key test works for the allowlisted GNAF + SAL — no signup.

Request

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

Query parameters

filterarrayoptional

Range filter `fieldKey:min..max` (repeatable). Valid fieldKeys: medianHousePrice, grossYield, medianRent, growthForecast4yr, growth10yrCagr, growth3yrCagr, rentGrowth3yr, soldAtLossPct, daysOnMarket, vacancyRate, 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.

statesstringoptional

Comma-separated states (names or abbreviations), e.g. `VIC`.

regionsstringoptional

Comma-separated EXACT SA4 region names — call GET /v1/suburbs/finder/regions for the list. A metro name like `Melbourne` alone will NOT match.

property_typestringoptional

'house' or 'unit'.

Responses

Successful Response

application/json

CountResponsefields returned to you

totalintegeralways returned

Suburbs matching every range filter (after the hard exclusions).

GET/v1/suburbs/finder/count

cURL

curl --request GET \
  --url 'https://api.microburbs.com.au/v1/suburbs/finder/count' \
  --header 'Authorization: Bearer test'

Example Responses

Show schema

{
  "data": {
    "total": 126
  }
}

Successful Response200

application/json