Search listings in a region
listings_searchSearch 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,sa4orlga— 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=900000Off-market listings in a council area, newest first:
/v1/listings/search?lga=Lake Macquarie&off_market=trueRentals 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
Price: 30¢ per call.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "listings_search"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| lat | No | Centre latitude for a radius search (WGS84). | |
| lga | No | A council (LGA) name, as `/v1/lga/list` returns it (e.g. `Lake Macquarie`): searches the suburbs whose main council it is. | |
| lon | No | Centre longitude for a radius search (WGS84). | |
| sa3 | No | An SA3 name: searches the suburbs whose main SA3 it is (e.g. `Lake Macquarie - East`). | |
| sa4 | No | An SA4 name, as `/v1/sa4/list` returns it (e.g. `Newcastle and Lake Macquarie`). | |
| sort | No | Sort key. Listings without the value sort last either way. | newest |
| limit | No | Rows per page, at most 25. `total` always reports the full match count. | |
| order | No | Sort direction. | desc |
| offset | No | 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. | |
| status | No | `sale` for listings on the market now (default), `rent` for rentals live now. | sale |
| suburbs | No | Comma-separated suburb names, up to 20 — spelt as the suburb endpoints take them (`Belmont North`, `St Kilda (Vic.)`). | |
| verbose | No | Include the agent's full ad copy in `attributes.description`. Off by default — it averages ~1.5 KB per listing. | |
| radius_m | No | Radius in metres around `lat`/`lon`, 100–10000. | |
| max_price | No | AUD. Weekly rent when `status=rent`. | |
| min_price | No | AUD. Weekly rent when `status=rent`. Listings with no stated price never match a price filter. | |
| off_market | No | 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. | |
| listed_after | No | Only listings first advertised on or after this date (YYYY-MM-DD). | |
| max_bedrooms | No | ||
| min_bedrooms | No | ||
| listed_before | No | Only listings first advertised on or before this date. | |
| max_bathrooms | No | ||
| max_land_size | No | Advertised land size, m². | |
| min_bathrooms | No | ||
| min_land_size | No | Advertised land size, m². Listings that do not state one never match. | |
| property_type | No | `house` (houses, cottages, acreage) or `unit` (apartments, units, townhouses, villas, terraces, duplexes, studios). Omit for both. | |
| max_car_spaces | No | ||
| min_car_spaces | No |