Microburbs
Microburbs API
Free sandbox: try any request below on the sample suburbs, no signup. For every suburb, create an API key.
Classic docs
Microburbs Property Data API
Property - Context

Rent by mesh block — advertised rents, our estimate, yield within 1 km (by gnaf_id)

GET/v1/properties/{gnaf_id}/mesh-blocks/rent30¢ per call

What does it cost to rent here? For every mesh block around the property: 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 within 1,000 m of the property under mesh_blocks, nearest first, each with its mb_code, distance_m, population and dwellings. Blocks across suburb lines are included. Values only — the polygons come from /properties/{gnaf_id}/context/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 (not labelled yet) — plus how, one sentence on how the number was arrived at (empty when not_recorded).

About this data ↓

Authorization

Request

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

Path parameters

gnaf_idstringrequired

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
PropertyMbTopicfields returned to you
gnaf_idstringalways returned

The property, as given.

suburbstringmay be null

The property's suburb (SAL). Blocks across suburb lines are included.

statestringmay be null

State / Territory abbreviation of the property.

radius_mintegeralways returned

Radius around the property, in metres (1,000).

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 PropertyMbTopicBlockalways returned

One entry per mesh block within `radius_m`, nearest first.

notestringalways returned

How to read `provenance`.

About this data

What this is

Rents around one address, block by block: for each mesh block within 1 km, the advertised weekly rents recorded on that block, our weekly rent estimate and gross rental yield, and the median rent for the surrounding SA1.

What people use it for

  • Investors: check what rent a home on this street can realistically ask, and the gross rental yield it implies.
  • Property managers: set or defend a rent with block-level evidence instead of a suburb median.
  • Tenants: see whether an advertised rent is in line with nearby blocks.
  • Lenders and valuers: a rental cross-check for a specific site.

Coverage

Mesh blocks nationwide (about 368,000). The 1 km radius crosses suburb lines. A field is null where we hold nothing for that block.

Tips

Advertised rents can be old: check rent_advertised_typical_year on the same block before treating them as current. For current asking rents use /v1/suburbs/{suburb_name}/listings/for-rent. Check provenance before quoting a field. Whole suburb: /v1/suburbs/{suburb_name}/mesh-blocks/rent. Polygons: /v1/properties/{gnaf_id}/context/mesh-blocks, joined on mb_code.

GET/v1/properties/{gnaf_id}/mesh-blocks/rent
cURL
curl --request GET \
  --url 'https://api.microburbs.com.au/v1/properties/GANSW704074813/mesh-blocks/rent' \
  --header 'Authorization: Bearer test'
Example Responses
{
  "data": {
    "gnaf_id": "GANSW704074813",
    "suburb": "Belmont North",
    "state": "NSW",
    "radius_m": 1000,
    "topic": "rent",
    "question": "What does it cost to rent here?",
    "beta": false,
    "block_count": 102,
    "mesh_blocks": [
      {
        "mb_code": "10434270000",
        "population": 124,
        "dwellings": 46,
        "fields": {
          "rent_advertised_median_weekly": {
            "value": 480,
            "unit": "AUD per week",
            "measured_at": "property_records",
            "label": "Median of the latest advertised weekly rents on this block",
            "provenance": "measured",
            "how": "measured from the records of the properties on this Microburb. Dated by `rent_advertised_typical_year` on the same block: the typical year those rents were advertised, which can be well in the past."
          },
          "rent_advertised_low_weekly": {
            "value": 340,
            "unit": "AUD per week",
            "measured_at": "property_records",
            "label": "Lowest latest advertised weekly rent on this block",
            "provenance": "measured",
            "how": "measured from the records of the properties on this Microburb. Dated by `rent_advertised_typical_year` on the same block: the typical year those rents were advertised, which can be well in the past."
          },
          "rent_advertised_high_weekly": {
            "value": 800,
            "unit": "AUD per week",
            "measured_at": "property_records",
            "label": "Highest latest advertised weekly rent on this block",
            "provenance": "measured",
            "how": "measured from the records of the properties on this Microburb. Dated by `rent_advertised_typical_year` on the same block: the typical year those rents were advertised, which can be well in the past."
          },
          "rent_advertised_properties": {
            "value": 7,
            "unit": "count",
            "measured_at": "property_records",
            "label": "Properties on this block with an advertised rent on record",
            "provenance": "measured",
            "how": "measured from the records of the properties on this Microburb. Dated by `rent_advertised_typical_year` on the same block: the typical year those rents were advertised, which can be well in the past."
          },
          "rent_advertised_typical_year": {
            "value": 2023,
            "unit": "year",
            "measured_at": "property_records",
            "label": "Typical year those rents were advertised",
            "provenance": "measured",
            "how": "measured from the records of the properties on this Microburb"
          },
          "rent_estimate_weekly": {
            "value": 644,
            "unit": "AUD per week",
            "label": "Our weekly rent for this block",
            "provenance": "estimate",
            "how": "our estimate for this Microburb"
          },
          "rent_vs_suburb_ratio": {
            "value": 0.99,
            "unit": "ratio",
            "label": "This block's rent relative to its suburb's median",
            "provenance": "estimate",
            "how": "our estimate for this Microburb"
          },
          "gross_yield_pct": {
            "value": 4.01,
            "unit": "%",
            "label": "Gross rental yield (our weekly rent x 52 over the block's house value)",
            "provenance": "estimate",
            "how": "our estimate for this Microburb"
          },
          "area_median_rent_weekly": {
            "value": 310,
            "unit": "AUD per week",
            "measured_at": "sa1",
            "label": "Median weekly rent, all dwelling types, surrounding area",
            "provenance": "measured_wider_area",
            "how": "measured for the surrounding area (SA1), repeated on this Microburb"
          }
        },
        "distance_m": 0
      },
      {
        "mb_code": "10434330000",
        "population": 89,
        "dwellings": 32,
        "fields": {
          "rent_advertised_median_weekly": {
            "value": 530,
            "unit": "AUD per week",
            "measured_at": "property_records",
            "label": "Median of the latest advertised weekly rents on this block",
            "provenance": "measured",
            "how": "measured from the records of the properties on this Microburb. Dated by `rent_advertised_typical_year` on the same block: the typical year those rents were advertised, which can be well in the past."
          },
          "rent_advertised_low_weekly": {
            "value": 320,
            "unit": "AUD per week",
            "measured_at": "property_records",
            "label": "Lowest latest advertised weekly rent on this block",
            "provenance": "measured",
            "how": "measured from the records of the properties on this Microburb. Dated by `rent_advertised_typical_year` on the same block: the typical year those rents were advertised, which can be well in the past."
          },
          "rent_advertised_high_weekly": {
            "value": 685,
            "unit": "AUD per week",
            "measured_at": "property_records",
            "label": "Highest latest advertised weekly rent on this block",
            "provenance": "measured",
            "how": "measured from the records of the properties on this Microburb. Dated by `rent_advertised_typical_year` on the same block: the typical year those rents were advertised, which can be well in the past."
          },
          "rent_advertised_properties": {
            "value": 4,
            "unit": "count",
            "measured_at": "property_records",
            "label": "Properties on this block with an advertised rent on record",
            "provenance": "measured",
            "how": "measured from the records of the properties on this Microburb. Dated by `rent_advertised_typical_year` on the same block: the typical year those rents were advertised, which can be well in the past."
          },
          "rent_advertised_typical_year": {
            "value": 2022,
            "unit": "year",
            "measured_at": "property_records",
            "label": "Typical year those rents were advertised",
            "provenance": "measured",
            "how": "measured from the records of the properties on this Microburb"
          },
          "rent_estimate_weekly": {
            "value": 619,
            "unit": "AUD per week",
            "label": "Our weekly rent for this block",
            "provenance": "estimate",
            "how": "our estimate for this Microburb"
          },
          "rent_vs_suburb_ratio": {
            "value": 0.95,
            "unit": "ratio",
            "label": "This block's rent relative to its suburb's median",
            "provenance": "estimate",
            "how": "our estimate for this Microburb"
          },
          "gross_yield_pct": {
            "value": 4.39,
            "unit": "%",
            "label": "Gross rental yield (our weekly rent x 52 over the block's house value)",
            "provenance": "estimate",
            "how": "our estimate for this Microburb"
          },
          "area_median_rent_weekly": {
            "value": 310,
            "unit": "AUD per week",
            "measured_at": "sa1",
            "label": "Median weekly rent, all dwelling types, surrounding area",
            "provenance": "measured_wider_area",
            "how": "measured for the surrounding area (SA1), repeated on this Microburb"
          }
        },
        "distance_m": 15
      },
      {
        "mb_code": "10434440000",
        "population": 99,
        "dwellings": 34,
        "fields": {
          "rent_advertised_median_weekly": {
            "value": 585,
            "unit": "AUD per week",
            "measured_at": "property_records",
            "label": "Median of the latest advertised weekly rents on this block",
            "provenance": "measured",
            "how": "measured from the records of the properties on this Microburb. Dated by `rent_advertised_typical_year` on the same block: the typical year those rents were advertised, which can be well in the past."
          },
          "rent_advertised_low_weekly": {
            "value": 320,
            "unit": "AUD per week",
            "measured_at": "property_records",
            "label": "Lowest latest advertised weekly rent on this block",
            "provenance": "measured",
            "how": "measured from the records of the properties on this Microburb. Dated by `rent_advertised_typical_year` on the same block: the typical year those rents were advertised, which can be well in the past."
          },
          "rent_advertised_high_weekly": {
            "value": 1000,
            "unit": "AUD per week",
            "measured_at": "property_records",
            "label": "Highest latest advertised weekly rent on this block",
            "provenance": "measured",
            "how": "measured from the records of the properties on this Microburb. Dated by `rent_advertised_typical_year` on the same block: the typical year those rents were advertised, which can be well in the past."
          },
          "rent_advertised_properties": {
            "value": 6,
            "unit": "count",
            "measured_at": "property_records",
            "label": "Properties on this block with an advertised rent on record",
            "provenance": "measured",
            "how": "measured from the records of the properties on this Microburb. Dated by `rent_advertised_typical_year` on the same block: the typical year those rents were advertised, which can be well in the past."
          },
          "rent_advertised_typical_year": {
            "value": 2020,
            "unit": "year",
            "measured_at": "property_records",
            "label": "Typical year those rents were advertised",
            "provenance": "measured",
            "how": "measured from the records of the properties on this Microburb"
          },
          "rent_estimate_weekly": {
            "value": 712,
            "unit": "AUD per week",
            "label": "Our weekly rent for this block",
            "provenance": "estimate",
            "how": "our estimate for this Microburb"
          },
          "rent_vs_suburb_ratio": {
            "value": 1.1,
            "unit": "ratio",
            "label": "This block's rent relative to its suburb's median",
            "provenance": "estimate",
            "how": "our estimate for this Microburb"
          },
          "gross_yield_pct": {
            "value": 3.38,
            "unit": "%",
            "label": "Gross rental yield (our weekly rent x 52 over the block's house value)",
            "provenance": "estimate",
            "how": "our estimate for this Microburb"
          },
          "area_median_rent_weekly": {
            "value": 310,
            "unit": "AUD per week",
            "measured_at": "sa1",
            "label": "Median weekly rent, all dwelling types, surrounding area",
            "provenance": "measured_wider_area",
            "how": "measured for the surrounding area (SA1), repeated on this Microburb"
          }
        },
        "distance_m": 56
      }
    ],
    "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