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
Listings

Search listings in a region

GET/v1/listings/search30¢ per call

Search the listings live right now across a region, with the filters of our Property Finder, and get back the same rows as the suburb listings endpoints.

What it is. Our Property Finder as one API call: every property for sale (or for rent) in the area you name, one row per property, filtered and sorted the way the finder does it, with each listing's address, price line, beds, baths and car spaces, land and floor area, coordinates, an off_market flag, the agency's own listing page and the named agents.

Where to search — give exactly one:

  • suburbs — up to 20 suburb names, comma-separated;
  • sa3, sa4 or lga — a whole statistical area or council;
  • lat + lon + radius_m — a circle of up to 10 km.

Filters (all optional, combine freely): min_/max_ bedrooms, bathrooms, car_spaces, price and land_size; property_type (house / unit); off_market; and listed_after / listed_before on the date the listing was first advertised. A listing that does not state a value never matches a filter on it. A listing seen on only one major portal, with no agency page of its own, keeps its address, type and agency name but not its advertised facts — and so never matches a filter on those facts and sorts last on them.

Sort and page. sort = newest (default), price, bedrooms or land_size, with order asc / desc. Pages of up to 25 rows: total is the full match count and next_offset the next page's offset. Each page is one call at a flat price.

Examples

  • Three-bedroom houses under $900,000 in two suburbs: /v1/listings/search?suburbs=Belmont North,Belmont (NSW)&property_type=house&min_bedrooms=3&max_price=900000
  • Off-market listings in a council area, newest first: /v1/listings/search?lga=Lake Macquarie&off_market=true
  • Rentals within 2 km of a point, cheapest first: /v1/listings/search?status=rent&lat=-32.97&lon=151.67&radius_m=2000&sort=price&order=asc
About this data ↓

Authorization

Request

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

Query parameters

statusstringoptional

`sale` for listings on the market now (default), `rent` for rentals live now.

suburbsstringoptional

Comma-separated suburb names, up to 20 — spelt as the suburb endpoints take them (`Belmont North`, `St Kilda (Vic.)`).

sa3stringoptional

An SA3 name: searches the suburbs whose main SA3 it is (e.g. `Lake Macquarie - East`).

sa4stringoptional

An SA4 name, as `/v1/sa4/list` returns it (e.g. `Newcastle and Lake Macquarie`).

lgastringoptional

A council (LGA) name, as `/v1/lga/list` returns it (e.g. `Lake Macquarie`): searches the suburbs whose main council it is.

latnumberoptional

Centre latitude for a radius search (WGS84).

lonnumberoptional

Centre longitude for a radius search (WGS84).

radius_mintegeroptional

Radius in metres around `lat`/`lon`, 100–10000.

min_bedroomsinteger0–∞optional
max_bedroomsinteger0–∞optional
min_bathroomsinteger0–∞optional
max_bathroomsinteger0–∞optional
min_car_spacesinteger0–∞optional
max_car_spacesinteger0–∞optional
min_pricenumber0–∞optional

AUD. Weekly rent when `status=rent`. Listings with no stated price never match a price filter.

max_pricenumber0–∞optional

AUD. Weekly rent when `status=rent`.

min_land_sizenumber0–∞optional

Advertised land size, m². Listings that do not state one never match.

max_land_sizenumber0–∞optional

Advertised land size, m².

property_typestringoptional

`house` (houses, cottages, acreage) or `unit` (apartments, units, townhouses, villas, terraces, duplexes, studios). Omit for both.

off_marketbooleanoptional

Only OFF-MARKET listings: on none of the major listing portals, sourced from the agency's own site, and still believed live — our Property Finder's 'Off market only' rule.

not sent · default false
listed_afterstring · dateoptional

Only listings first advertised on or after this date (YYYY-MM-DD).

listed_beforestring · dateoptional

Only listings first advertised on or before this date.

sortoptionalrank the results by a field
orderstringoptional

Sort direction.

limitintegeroptional

Rows per page, at most 25. `total` always reports the full match count.

offsetinteger0–∞optional

Row offset for paging. `next_offset` in the response is the value for the next page (null on the last). Each page is a separate call.

verbosebooleanoptional

Include the agent's full ad copy in `attributes.description`. Off by default — it averages ~1.5 KB per listing.

not sent · default false

Responses

Successful Response

application/json
ListingSearchfields returned to you
resultsarray of SearchListingmay be null

The matching listings, one per property: `limit` rows from `offset`, in `sort` order.

totalintegermay be null

Every listing that matches, counted before paging, so it stays accurate when the rows are capped.

next_offsetintegermay be null

`offset` to pass for the next page, or null when this is the last page.

About this data

What this is

Our Property Finder as one API call. Name an area (suburbs, an SA3 or SA4, a council, or a circle on the map), set the filters you care about, and get back every live listing that matches, one row per property.

It covers homes for sale and for rent, including off-market listings found only on agency websites, which no portal search shows. Duplicates across sites are merged, so each property appears once.

What people use it for

  • Buyer and investor tools: "3-bed houses under $900k within 2 km of this school".
  • Buyers' agents: saved searches that run every morning across a client's target suburbs.
  • Rental tools: cheapest rentals near a point, or new rentals listed this week.
  • Market dashboards: how many listings match a brief, and how that number moves.

Tips

Combine any filters. A listing that doesn't state a value (no price, no land size) never matches a filter on it, so loosen filters before concluding stock is thin. total is the full match count, so a count costs one call.

GET/v1/listings/search
cURL
curl --request GET \
  --url 'https://api.microburbs.com.au/v1/listings/search' \
  --header 'Authorization: Bearer test'
Example Responses
{
  "data": {
    "next_offset": 2,
    "results": [
      {
        "address": {
          "sa1": "11101120628",
          "sal": "Belmont North",
          "state": "NSW",
          "street": "300 Pacific Highway"
        },
        "agency": {
          "agents": [],
          "name": "Example Realty"
        },
        "area_level": "address",
        "area_name": "300 Pacific Highway, Belmont North, NSW",
        "attributes": {
          "bathrooms": 2,
          "bedrooms": 4,
          "garage_spaces": 2,
          "land_size": 592
        },
        "coordinates": {
          "latitude": -33.01789865,
          "longitude": 151.66869797
        },
        "display_price": "$970,000 to $1,020,000",
        "gnaf_pid": "GANSW704073859",
        "listing_date": "2026-11-04",
        "listing_id": "121b568dd50815979d9e0ae8cc7d5eaf",
        "off_market": false,
        "price": 970000,
        "price_high": 1020000,
        "price_low": 970000,
        "property_type": "House",
        "property_type_raw": "House"
      },
      {
        "address": {
          "sa1": "11101120602",
          "sal": "Belmont North",
          "state": "NSW",
          "street": "18 Sunrise Close"
        },
        "agency": {
          "agents": [
            {
              "email": "[email protected]",
              "id": "ea56b26663fda909898e0866786e964d",
              "name": "Agent Name",
              "phone": "0400 000 000"
            }
          ],
          "name": "Example Realty"
        },
        "area_level": "address",
        "area_name": "18 Sunrise Close, Belmont North, NSW",
        "attributes": {
          "bathrooms": 2,
          "bedrooms": 4,
          "building_size": 195,
          "garage_spaces": 4,
          "land_size": 10100
        },
        "coordinates": {
          "latitude": -33.00933909,
          "longitude": 151.67645564
        },
        "display_price": "$1,750,000",
        "gnaf_pid": "GANSW704080709",
        "listing_date": "2026-10-23",
        "listing_id": "f2e1e55fa1017934325c5af7f1990a28",
        "off_market": false,
        "price": 1750000,
        "property_type": "House",
        "property_type_raw": "house"
      }
    ],
    "total": 22
  }
}
Successful Response200
application/json