Microburbs
Microburbs API
Live sandbox. Send any request below against one sample suburb and property — no signup needed. For full coverage, create an API key.
Classic docs
Microburbs Property Data API
Suburb - Market

Rent by mesh block — advertised rents, our estimate, yield (by suburb)

GET/v1/suburbs/{suburb_name}/mesh-blocks/rent30¢ per call

What does it cost to rent here? For every mesh block in the suburb: advertised weekly rents recorded on the block (median, range, how many properties, typical year), our weekly rent and gross yield for the block, and the median rent for the surrounding area.

One entry per mesh block in the suburb under mesh_blocks, each with its mb_code, population and dwellings. Values only — the matching polygons come from /shapes/mesh-blocks.

Every field carries provenance — measured (at this block), measured_wider_area (measured for the SA1 or postcode and repeated on every block in it), estimate (our model) or not_recorded — plus how, one sentence on how the number was arrived at.

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: 30¢ per call.

Authorization

Request

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

Path parameters

suburb_namestringrequired

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.

Query parameters

None — this endpoint accepts no query parameters. Call the path above with your bearer token and nothing else.

Responses

Successful Response

application/json
SuburbMbTopicfields returned to you
suburbstringalways returned

Suburb (SAL) name, as resolved.

statestringmay be null

State / Territory abbreviation.

topicstringalways returned

Which topic this answers.

questionstringalways returned

The question this topic answers.

betabooleanalways returned

`true` when the figures behind this topic have not been validated against an independent source yet.

beta_noticestringmay be null

What is unvalidated, on beta topics only.

block_countintegeralways returned

How many mesh blocks are in `mesh_blocks`.

mesh_blocksarray of MbTopicBlockalways returned

One entry per mesh block in the suburb, ordered by `mb_code`.

notestringalways returned

How to read `provenance`.

GET/v1/suburbs/{suburb_name}/mesh-blocks/rent
cURL
curl --request GET \
  --url 'https://api.microburbs.com.au/v1/suburbs/Belmont%20North/mesh-blocks/rent' \
  --header 'Authorization: Bearer test'
Example Responses
{
  "data": {
    "suburb": "Belmont North",
    "state": "NSW",
    "topic": "rent",
    "question": "What does it cost to rent here?",
    "beta": false,
    "block_count": 85,
    "mesh_blocks": [
      {
        "mb_code": "10434270000",
        "population": 124,
        "dwellings": 46,
        "fields": {
          "rent_advertised_median_weekly": {
            "value": 480,
            "label": "Median of the latest advertised weekly rents on this block",
            "unit": "AUD per week",
            "provenance": "measured",
            "measured_at": "property_records",
            "how": "measured from the records of the properties on this Microburb"
          },
          "rent_advertised_low_weekly": {
            "value": 340,
            "label": "Lowest latest advertised weekly rent on this block",
            "unit": "AUD per week",
            "provenance": "measured",
            "measured_at": "property_records",
            "how": "measured from the records of the properties on this Microburb"
          },
          "rent_advertised_high_weekly": {
            "value": 800,
            "label": "Highest latest advertised weekly rent on this block",
            "unit": "AUD per week",
            "provenance": "measured",
            "measured_at": "property_records",
            "how": "measured from the records of the properties on this Microburb"
          },
          "rent_advertised_properties": {
            "value": 7,
            "label": "Properties on this block with an advertised rent on record",
            "unit": "count",
            "provenance": "measured",
            "measured_at": "property_records",
            "how": "measured from the records of the properties on this Microburb"
          },
          "rent_advertised_typical_year": {
            "value": 2023,
            "label": "Typical year those rents were advertised",
            "unit": "year",
            "provenance": "measured",
            "measured_at": "property_records",
            "how": "measured from the records of the properties on this Microburb"
          },
          "rent_estimate_weekly": {
            "value": 644,
            "label": "Our weekly rent for this block",
            "unit": "AUD per week",
            "provenance": "estimate",
            "how": "our estimate for this Microburb"
          },
          "rent_vs_suburb_ratio": {
            "value": 0.99,
            "label": "This block's rent relative to its suburb's median",
            "unit": "ratio",
            "provenance": "estimate",
            "how": "our estimate for this Microburb"
          },
          "gross_yield_pct": {
            "value": 4.01,
            "label": "Gross rental yield (our weekly rent x 52 over the block's house value)",
            "unit": "%",
            "provenance": "estimate",
            "how": "our estimate for this Microburb"
          },
          "area_median_rent_weekly": {
            "value": 310,
            "label": "Median weekly rent, all dwelling types, surrounding area",
            "unit": "AUD per week",
            "provenance": "measured_wider_area",
            "measured_at": "sa1",
            "how": "measured for the surrounding area (SA1), repeated on this Microburb"
          }
        }
      },
      {
        "mb_code": "11205004200",
        "population": 189,
        "dwellings": 63,
        "fields": {
          "rent_advertised_median_weekly": {
            "value": 612,
            "label": "Median of the latest advertised weekly rents on this block",
            "unit": "AUD per week",
            "provenance": "measured",
            "measured_at": "property_records",
            "how": "measured from the records of the properties on this Microburb"
          },
          "rent_advertised_low_weekly": {
            "value": 520,
            "label": "Lowest latest advertised weekly rent on this block",
            "unit": "AUD per week",
            "provenance": "measured",
            "measured_at": "property_records",
            "how": "measured from the records of the properties on this Microburb"
          },
          "rent_advertised_high_weekly": {
            "value": 630,
            "label": "Highest latest advertised weekly rent on this block",
            "unit": "AUD per week",
            "provenance": "measured",
            "measured_at": "property_records",
            "how": "measured from the records of the properties on this Microburb"
          },
          "rent_advertised_properties": {
            "value": 4,
            "label": "Properties on this block with an advertised rent on record",
            "unit": "count",
            "provenance": "measured",
            "measured_at": "property_records",
            "how": "measured from the records of the properties on this Microburb"
          },
          "rent_advertised_typical_year": {
            "value": 2011,
            "label": "Typical year those rents were advertised",
            "unit": "year",
            "provenance": "measured",
            "measured_at": "property_records",
            "how": "measured from the records of the properties on this Microburb"
          },
          "rent_estimate_weekly": {
            "value": 693,
            "label": "Our weekly rent for this block",
            "unit": "AUD per week",
            "provenance": "estimate",
            "how": "our estimate for this Microburb"
          },
          "rent_vs_suburb_ratio": {
            "value": 1.07,
            "label": "This block's rent relative to its suburb's median",
            "unit": "ratio",
            "provenance": "estimate",
            "how": "our estimate for this Microburb"
          },
          "gross_yield_pct": {
            "value": 2.96,
            "label": "Gross rental yield (our weekly rent x 52 over the block's house value)",
            "unit": "%",
            "provenance": "estimate",
            "how": "our estimate for this Microburb"
          },
          "area_median_rent_weekly": {
            "value": 500,
            "label": "Median weekly rent, all dwelling types, surrounding area",
            "unit": "AUD per week",
            "provenance": "measured_wider_area",
            "measured_at": "sa1",
            "how": "measured for the surrounding area (SA1), repeated on this Microburb"
          }
        }
      },
      {
        "mb_code": "10436570000",
        "population": 169,
        "dwellings": 64,
        "fields": {
          "rent_advertised_median_weekly": {
            "value": 625,
            "label": "Median of the latest advertised weekly rents on this block",
            "unit": "AUD per week",
            "provenance": "measured",
            "measured_at": "property_records",
            "how": "measured from the records of the properties on this Microburb"
          },
          "rent_advertised_low_weekly": {
            "value": 290,
            "label": "Lowest latest advertised weekly rent on this block",
            "unit": "AUD per week",
            "provenance": "measured",
            "measured_at": "property_records",
            "how": "measured from the records of the properties on this Microburb"
          },
          "rent_advertised_high_weekly": {
            "value": 1250,
            "label": "Highest latest advertised weekly rent on this block",
            "unit": "AUD per week",
            "provenance": "measured",
            "measured_at": "property_records",
            "how": "measured from the records of the properties on this Microburb"
          },
          "rent_advertised_properties": {
            "value": 9,
            "label": "Properties on this block with an advertised rent on record",
            "unit": "count",
            "provenance": "measured",
            "measured_at": "property_records",
            "how": "measured from the records of the properties on this Microburb"
          },
          "rent_advertised_typical_year": {
            "value": 2017,
            "label": "Typical year those rents were advertised",
            "unit": "year",
            "provenance": "measured",
            "measured_at": "property_records",
            "how": "measured from the records of the properties on this Microburb"
          },
          "rent_estimate_weekly": {
            "value": 837,
            "label": "Our weekly rent for this block",
            "unit": "AUD per week",
            "provenance": "estimate",
            "how": "our estimate for this Microburb"
          },
          "rent_vs_suburb_ratio": {
            "value": 1.29,
            "label": "This block's rent relative to its suburb's median",
            "unit": "ratio",
            "provenance": "estimate",
            "how": "our estimate for this Microburb"
          },
          "gross_yield_pct": {
            "value": 4.19,
            "label": "Gross rental yield (our weekly rent x 52 over the block's house value)",
            "unit": "%",
            "provenance": "estimate",
            "how": "our estimate for this Microburb"
          },
          "area_median_rent_weekly": {
            "value": 595,
            "label": "Median weekly rent, all dwelling types, surrounding area",
            "unit": "AUD per week",
            "provenance": "measured_wider_area",
            "measured_at": "sa1",
            "how": "measured for the surrounding area (SA1), repeated on this Microburb"
          }
        }
      }
    ],
    "note": "Each field says how its number was arrived at. An estimate is not a measurement, and a figure measured for a wider area is not a measurement of the block."
  }
}
Successful Response200
application/json