Suburb - Finder

Count matching suburbs

How 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.

get/v1/suburbs/finder/count

Request

  • Base URL: https://api.microburbs.com.au
  • URL: https://api.microburbs.com.au/v1/suburbs/finder/count
  • Auth: HTTP bearer

Query parameters

filterstring[]

Range 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.

statesstring nullable

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

Example:VIC
regionsstring nullable

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_typestring

Legacy 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.

Response

Successful Response

availableboolean nullable

false on no-data responses. Omitted on success — branch on data !== null if you want a single discriminator.

reasonstring nullable

Machine-readable slug naming the no-data condition (e.g. no_avm_for_GANSW704074813). Stable per endpoint. Omitted on success.

messagestring nullable

Human-readable explanation. Omitted on success.

Example response

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

Changes

No recorded changes to this operation across all 1 revision of this API.