Microburbs
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

Transport by mesh block — stops, stations, commuting within 1 km (by gnaf_id)

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

How do you get around from here? For every mesh block around the property: distance to the nearest bus stop, train station and tram stop, bus stops within 320 m, and how many workers commute by public transport.

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

Public transport around one address, block by block: for each mesh block within 1 km, the distance to the nearest bus stop, train station and tram stop, the number of bus stops within 320 m, and the share of workers who commute by public transport.

What people use it for

  • Buyers and renters: check how far a home really is from the station.
  • Agents: back up "walk to transport" claims with distances.
  • Developers and planners: assess transit access around a 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

The commuting share is our estimate; distances are measured. For named stops and stations use /v1/properties/{gnaf_id}/transport/nearby. Check provenance before quoting a field. Whole suburb: /v1/suburbs/{suburb_name}/mesh-blocks/transport. Polygons: /v1/properties/{gnaf_id}/context/mesh-blocks, joined on mb_code.

GET/v1/properties/{gnaf_id}/mesh-blocks/transport
cURL
curl --request GET \
  --url 'https://api.microburbs.com.au/v1/properties/GANSW704074813/mesh-blocks/transport' \
  --header 'Authorization: Bearer test'
Example Responses
{
  "data": {
    "gnaf_id": "GANSW704074813",
    "suburb": "Belmont North",
    "state": "NSW",
    "radius_m": 1000,
    "topic": "transport",
    "question": "How do you get around from here?",
    "beta": false,
    "block_count": 102,
    "mesh_blocks": [
      {
        "mb_code": "10434270000",
        "population": 124,
        "dwellings": 46,
        "fields": {
          "bus_stop_nearest_m": {
            "value": 533.64,
            "unit": "metres",
            "measured_at": "mesh_block",
            "label": "Nearest bus stop",
            "provenance": "measured",
            "how": "measured at this level"
          },
          "train_station_nearest_m": {
            "value": 8187.3,
            "unit": "metres",
            "measured_at": "mesh_block",
            "label": "Nearest train station",
            "provenance": "measured",
            "how": "measured at this level"
          },
          "tram_stop_nearest_m": {
            "value": 127623.22,
            "unit": "metres",
            "measured_at": "mesh_block",
            "label": "Nearest tram stop",
            "provenance": "measured",
            "how": "measured at this level"
          },
          "bus_stops_within_320m": {
            "value": 0,
            "unit": "count",
            "measured_at": "mesh_block",
            "label": "Bus stops within 320 m",
            "provenance": "measured",
            "how": "measured at this level"
          },
          "public_transport_to_work_pct": {
            "value": 1.55,
            "unit": "% of workers",
            "label": "Workers who commute by public transport",
            "provenance": "estimate",
            "how": "our estimate for this Microburb"
          },
          "listed_close_to_public_transport_pct": {
            "value": 0,
            "unit": "% of listings",
            "measured_at": "mesh_block",
            "label": "Listings that describe themselves as close to public transport",
            "provenance": "measured",
            "how": "measured at this level"
          }
        },
        "distance_m": 0
      },
      {
        "mb_code": "10434330000",
        "population": 89,
        "dwellings": 32,
        "fields": {
          "bus_stop_nearest_m": {
            "value": 630.42,
            "unit": "metres",
            "measured_at": "mesh_block",
            "label": "Nearest bus stop",
            "provenance": "measured",
            "how": "measured at this level"
          },
          "train_station_nearest_m": {
            "value": 8244.62,
            "unit": "metres",
            "measured_at": "mesh_block",
            "label": "Nearest train station",
            "provenance": "measured",
            "how": "measured at this level"
          },
          "tram_stop_nearest_m": {
            "value": 127523.11,
            "unit": "metres",
            "measured_at": "mesh_block",
            "label": "Nearest tram stop",
            "provenance": "measured",
            "how": "measured at this level"
          },
          "bus_stops_within_320m": {
            "value": 0,
            "unit": "count",
            "measured_at": "mesh_block",
            "label": "Bus stops within 320 m",
            "provenance": "measured",
            "how": "measured at this level"
          },
          "public_transport_to_work_pct": {
            "value": 1.55,
            "unit": "% of workers",
            "label": "Workers who commute by public transport",
            "provenance": "estimate",
            "how": "our estimate for this Microburb"
          },
          "listed_close_to_public_transport_pct": {
            "value": 20,
            "unit": "% of listings",
            "measured_at": "mesh_block",
            "label": "Listings that describe themselves as close to public transport",
            "provenance": "measured",
            "how": "measured at this level"
          }
        },
        "distance_m": 15
      },
      {
        "mb_code": "10434440000",
        "population": 99,
        "dwellings": 34,
        "fields": {
          "bus_stop_nearest_m": {
            "value": 359.41,
            "unit": "metres",
            "measured_at": "mesh_block",
            "label": "Nearest bus stop",
            "provenance": "measured",
            "how": "measured at this level"
          },
          "train_station_nearest_m": {
            "value": 8160.54,
            "unit": "metres",
            "measured_at": "mesh_block",
            "label": "Nearest train station",
            "provenance": "measured",
            "how": "measured at this level"
          },
          "tram_stop_nearest_m": {
            "value": 127793.88,
            "unit": "metres",
            "measured_at": "mesh_block",
            "label": "Nearest tram stop",
            "provenance": "measured",
            "how": "measured at this level"
          },
          "bus_stops_within_320m": {
            "value": 0,
            "unit": "count",
            "measured_at": "mesh_block",
            "label": "Bus stops within 320 m",
            "provenance": "measured",
            "how": "measured at this level"
          },
          "public_transport_to_work_pct": {
            "value": 1.77,
            "unit": "% of workers",
            "label": "Workers who commute by public transport",
            "provenance": "estimate",
            "how": "our estimate for this Microburb"
          },
          "listed_close_to_public_transport_pct": {
            "value": 50,
            "unit": "% of listings",
            "measured_at": "mesh_block",
            "label": "Listings that describe themselves as close to public transport",
            "provenance": "measured",
            "how": "measured at this level"
          }
        },
        "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