Suburb - Market

Gross rental yield per microburb

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

get/v1/suburbs/{suburb_name}/market/yield-map

Request

  • Base URL: https://api.microburbs.com.au
  • URL: https://api.microburbs.com.au/v1/suburbs/{suburb_name}/market/yield-map
  • Auth: HTTP bearer

Path parameters

suburb_namestring required
Example:Belmont North

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.

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": {
    "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.",
    "highest": {
      "gross_yield_pct": 6.65,
      "mb": "10439020000",
      "median_price": 892000,
      "street": "Floraville",
      "weekly_rent": 1140
    },
    "lowest": {
      "gross_yield_pct": 1.85,
      "mb": "10434330000",
      "median_price": 1600000,
      "street": "Arlington",
      "weekly_rent": 570
    },
    "metric": "gross_rental_yield_house",
    "microburbs": [
      {
        "gross_yield_pct": 6.65,
        "mb": "10439020000",
        "median_price": 892000,
        "street": "Floraville",
        "weekly_rent": 1140
      }
    ],
    "n_microburbs": 58,
    "suburb": "Belmont North",
    "unit": "percent"
  }
}

Changes

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