Business by mesh block — shops, cafes and services nearby within 1 km (by gnaf_id)
/v1/properties/{gnaf_id}/mesh-blocks/business20¢ per callWhat's nearby? For every mesh block around the property: distance to the nearest supermarket, cafe, restaurant, bakery, pharmacy, GP and pub, and how many cafes, restaurants and supermarkets are within 320 m.
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).
Authorization
Request
The only values you send. Fields under Responses below are what comes back — you never pass those.
Path parameters
gnaf_idstringrequiredQuery parameters
Responses
Successful Response
gnaf_idstringalways returnedThe property, as given.
suburbstringmay be nullThe property's suburb (SAL). Blocks across suburb lines are included.
statestringmay be nullState / Territory abbreviation of the property.
radius_mintegeralways returnedRadius around the property, in metres (1,000).
topicstringalways returnedWhich topic this answers.
questionstringalways returnedThe 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 nullWhat is unvalidated, on beta topics only.
block_countintegeralways returnedHow many mesh blocks are in `mesh_blocks`.
mesh_blocksarray of PropertyMbTopicBlockalways returnedOne entry per mesh block within `radius_m`, nearest first.
notestringalways returnedHow to read `provenance`.
About this data
What this is
Everyday shops and services around one address, block by block: for each mesh block within 1 km, the distance to the nearest supermarket, cafe, restaurant, bakery, pharmacy, GP and pub, and how many cafes, restaurants and supermarkets are within 320 m.
What people use it for
- Buyers and renters: check how walkable daily errands are from a particular home.
- Agents: back up "close to shops and cafes" in a listing with distances.
- Retailers and site selectors: gauge how well served the blocks around a site already are.
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
320 m is roughly a four-minute walk. For named places with addresses use /v1/properties/{gnaf_id}/amenities/nearby. Check provenance before quoting a field. Whole suburb: /v1/suburbs/{suburb_name}/mesh-blocks/business. Polygons: /v1/properties/{gnaf_id}/context/mesh-blocks, joined on mb_code.
/v1/properties/{gnaf_id}/mesh-blocks/businesscurl --request GET \
--url 'https://api.microburbs.com.au/v1/properties/GANSW704074813/mesh-blocks/business' \
--header 'Authorization: Bearer test'{
"data": {
"gnaf_id": "GANSW704074813",
"suburb": "Belmont North",
"state": "NSW",
"radius_m": 1000,
"topic": "business",
"question": "What's nearby?",
"beta": false,
"block_count": 102,
"mesh_blocks": [
{
"mb_code": "10434270000",
"population": 124,
"dwellings": 46,
"fields": {
"supermarket_nearest_m": {
"value": 835.44,
"unit": "metres",
"measured_at": "mesh_block",
"label": "Nearest supermarket",
"provenance": "measured",
"how": "measured at this level"
},
"cafe_nearest_m": {
"value": 684.53,
"unit": "metres",
"measured_at": "mesh_block",
"label": "Nearest cafe",
"provenance": "measured",
"how": "measured at this level"
},
"restaurant_nearest_m": {
"value": 1478.66,
"unit": "metres",
"measured_at": "mesh_block",
"label": "Nearest restaurant",
"provenance": "measured",
"how": "measured at this level"
},
"bakery_nearest_m": {
"value": 835.26,
"unit": "metres",
"measured_at": "mesh_block",
"label": "Nearest bakery",
"provenance": "measured",
"how": "measured at this level"
},
"pharmacy_nearest_m": {
"value": 857.69,
"unit": "metres",
"measured_at": "mesh_block",
"label": "Nearest pharmacy",
"provenance": "measured",
"how": "measured at this level"
},
"doctors_nearest_m": {
"value": 770.4,
"unit": "metres",
"measured_at": "mesh_block",
"label": "Nearest GP clinic",
"provenance": "measured",
"how": "measured at this level"
},
"pub_nearest_m": {
"value": 870.65,
"unit": "metres",
"measured_at": "mesh_block",
"label": "Nearest pub",
"provenance": "measured",
"how": "measured at this level"
},
"cafes_within_320m": {
"value": 0,
"unit": "count",
"measured_at": "mesh_block",
"label": "Cafes within 320 m",
"provenance": "measured",
"how": "measured at this level"
},
"restaurants_within_320m": {
"value": 0,
"unit": "count",
"measured_at": "mesh_block",
"label": "Restaurants within 320 m",
"provenance": "measured",
"how": "measured at this level"
},
"supermarkets_within_320m": {
"value": 0,
"unit": "count",
"measured_at": "mesh_block",
"label": "Supermarkets within 320 m",
"provenance": "measured",
"how": "measured at this level"
}
},
"distance_m": 0
},
{
"mb_code": "10434330000",
"population": 89,
"dwellings": 32,
"fields": {
"supermarket_nearest_m": {
"value": 876.1,
"unit": "metres",
"measured_at": "mesh_block",
"label": "Nearest supermarket",
"provenance": "measured",
"how": "measured at this level"
},
"cafe_nearest_m": {
"value": 577.64,
"unit": "metres",
"measured_at": "mesh_block",
"label": "Nearest cafe",
"provenance": "measured",
"how": "measured at this level"
},
"restaurant_nearest_m": {
"value": 1399.96,
"unit": "metres",
"measured_at": "mesh_block",
"label": "Nearest restaurant",
"provenance": "measured",
"how": "measured at this level"
},
"bakery_nearest_m": {
"value": 877.47,
"unit": "metres",
"measured_at": "mesh_block",
"label": "Nearest bakery",
"provenance": "measured",
"how": "measured at this level"
},
"pharmacy_nearest_m": {
"value": 903.72,
"unit": "metres",
"measured_at": "mesh_block",
"label": "Nearest pharmacy",
"provenance": "measured",
"how": "measured at this level"
},
"doctors_nearest_m": {
"value": 805.83,
"unit": "metres",
"measured_at": "mesh_block",
"label": "Nearest GP clinic",
"provenance": "measured",
"how": "measured at this level"
},
"pub_nearest_m": {
"value": 918.32,
"unit": "metres",
"measured_at": "mesh_block",
"label": "Nearest pub",
"provenance": "measured",
"how": "measured at this level"
},
"cafes_within_320m": {
"value": 0,
"unit": "count",
"measured_at": "mesh_block",
"label": "Cafes within 320 m",
"provenance": "measured",
"how": "measured at this level"
},
"restaurants_within_320m": {
"value": 0,
"unit": "count",
"measured_at": "mesh_block",
"label": "Restaurants within 320 m",
"provenance": "measured",
"how": "measured at this level"
},
"supermarkets_within_320m": {
"value": 0,
"unit": "count",
"measured_at": "mesh_block",
"label": "Supermarkets within 320 m",
"provenance": "measured",
"how": "measured at this level"
}
},
"distance_m": 15
},
{
"mb_code": "10434440000",
"population": 99,
"dwellings": 34,
"fields": {
"supermarket_nearest_m": {
"value": 689.38,
"unit": "metres",
"measured_at": "mesh_block",
"label": "Nearest supermarket",
"provenance": "measured",
"how": "measured at this level"
},
"cafe_nearest_m": {
"value": 718.6,
"unit": "metres",
"measured_at": "mesh_block",
"label": "Nearest cafe",
"provenance": "measured",
"how": "measured at this level"
},
"restaurant_nearest_m": {
"value": 1657.38,
"unit": "metres",
"measured_at": "mesh_block",
"label": "Nearest restaurant",
"provenance": "measured",
"how": "measured at this level"
},
"bakery_nearest_m": {
"value": 687.41,
"unit": "metres",
"measured_at": "mesh_block",
"label": "Nearest bakery",
"provenance": "measured",
"how": "measured at this level"
},
"pharmacy_nearest_m": {
"value": 705.27,
"unit": "metres",
"measured_at": "mesh_block",
"label": "Nearest pharmacy",
"provenance": "measured",
"how": "measured at this level"
},
"doctors_nearest_m": {
"value": 631.94,
"unit": "metres",
"measured_at": "mesh_block",
"label": "Nearest GP clinic",
"provenance": "measured",
"how": "measured at this level"
},
"pub_nearest_m": {
"value": 716.3,
"unit": "metres",
"measured_at": "mesh_block",
"label": "Nearest pub",
"provenance": "measured",
"how": "measured at this level"
},
"cafes_within_320m": {
"value": 0,
"unit": "count",
"measured_at": "mesh_block",
"label": "Cafes within 320 m",
"provenance": "measured",
"how": "measured at this level"
},
"restaurants_within_320m": {
"value": 0,
"unit": "count",
"measured_at": "mesh_block",
"label": "Restaurants within 320 m",
"provenance": "measured",
"how": "measured at this level"
},
"supermarkets_within_320m": {
"value": 0,
"unit": "count",
"measured_at": "mesh_block",
"label": "Supermarkets within 320 m",
"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."
}
}