Search properties (coming soon)
/v1/properties/finder/search30¢ per callScreen listings within the given suburbs / regions. Returns matching listing facts (no AVM/forecast values — those are filter inputs). Flat 30c. Coming soon — temporarily unavailable (503).
Price: 30¢ per call.
Authorization
Request
The only values you send. Fields under Responses below are what comes back — you never pass those.
Query parameters
suburbsstringoptionalComma-separated SAL names. One of suburbs/regions required.
regionsstringoptionalComma-separated SA4 / SA3 region names.
neighborsbooleanoptionalInclude bordering suburbs (suburbs scope only).
property_typestringoptional'house' or 'unit' (omit for both).
min_bedroomsintegeroptionalmin_bathsintegeroptionalmin_carsintegeroptionalmin_pricenumberoptionalDefaults to 10000.
max_pricenumberoptionalmin_yieldnumberoptionalFraction, e.g. 0.045 for 4.5%.
max_yieldnumberoptionalmin_growthnumberoptionalFraction.
max_growthnumberoptionalmin_growth_forecastnumberoptionalFraction.
max_growth_forecastnumberoptionalfeaturesstringoptionalComma-separated feature keys (see /fields).
sort_bystringoptionalSort key (see /fields). Default: match_percentage.
sort_directionstringoptional'asc' or 'desc'.
limitintegeroptionalPage size (clamped to 200).
offsetintegeroptionalRow offset.
min_distance_to_schoolnumberoptionalmax_distance_to_schoolnumberoptionalmin_distance_to_public_housingnumberoptionalmax_distance_to_public_housingnumberoptionalmin_distance_to_supermarketnumberoptionalmax_distance_to_supermarketnumberoptionalmin_distance_to_parknumberoptionalmax_distance_to_parknumberoptionalmin_distance_to_beachnumberoptionalmax_distance_to_beachnumberoptionalmin_distance_to_railwaynumberoptionalmax_distance_to_railwaynumberoptionalmin_avm_estimatenumberoptionalmax_avm_estimatenumberoptionalmin_avm_confidencenumberoptionalmax_avm_confidencenumberoptionalmin_rental_avm_weeklynumberoptionalmax_rental_avm_weeklynumberoptionalmin_rental_avm_yieldnumberoptionalmax_rental_avm_yieldnumberoptionalmin_price_vs_avmnumberoptionale.g. 0.95 max = at least 5% under AVM.
max_price_vs_avmnumberoptionale.g. 0.95 = at least 5% under AVM.
min_avm_minus_pricenumberoptionale.g. 50000 = at least $50k under AVM.
max_avm_minus_pricenumberoptionalmin_suburb_median_house_pricenumberoptionalmax_suburb_median_house_pricenumberoptionalmin_suburb_median_unit_pricenumberoptionalmax_suburb_median_unit_pricenumberoptionalmin_suburb_growth_forecastnumberoptionalFraction — e.g. 0.05 for >5% suburb forecast.
max_suburb_growth_forecastnumberoptionalmin_suburb_gross_yieldnumberoptionalFraction.
max_suburb_gross_yieldnumberoptionalmin_suburb_growth_10yrnumberoptionalFraction (CAGR).
max_suburb_growth_10yrnumberoptionalmin_suburb_growth_3yrnumberoptionalFraction (CAGR).
max_suburb_growth_3yrnumberoptionalResponses
Successful Response
propertiesarray of PropertyRowalways returnedMatched properties, sorted.
metaobjectalways returnedPagination + total for a search.
/v1/properties/finder/searchcurl --request GET \
--url 'https://api.microburbs.com.au/v1/properties/finder/search' \
--header 'Authorization: Bearer test'{
"data": {
"meta": {
"limit": 25,
"offset": 0,
"returned": 25,
"total": 147
},
"properties": [
{
"gnafId": "GANSW704074813",
"address": "12 Beach Street",
"suburb": "Belmont North",
"state": "NSW",
"beds": 3,
"bath": 2,
"car": 2,
"property_type": "house",
"price": 650000,
"sqm": 450,
"price_per_sqmt": 1444.4,
"latitude": -33.0421,
"longitude": 151.6634,
"listing_date": "2026-05-15T00:00:00",
"distance_to_school": 850,
"distance_to_public_housing": 3200,
"distance_to_supermarket": 450,
"distance_to_park": 200,
"distance_to_beach": 1200,
"distance_to_railway": 2500,
"level_access": true,
"good_view_outlook": false,
"presence_of_ensuite": true,
"big_kitchen": true,
"presence_of_pool": false,
"entertaining_area": true,
"natural_light": true,
"match_percentage": 85
}
]
}
}