suburbs_listings_for_sale
Current for-sale listings in the suburb, with address, price, beds/baths and coordinates per listing.
total is the full number on the market (computed before limit), so a
count is accurate even when the rows are capped. Raise limit for more
listings; set verbose=true for the agent's full description text.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Max listings to return (default 30, max 200). `total` always reports the full match count. | |
| verbose | No | Include the agent's full ad-copy in `attributes.description`. Off by default — it averages ~1.5 KB per listing. | |
| suburb_name | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | No | The endpoint's payload, or `null` when Microburbs has no value. | |
| reason | No | Machine-readable slug naming the no-data condition (e.g. `no_avm_for_GANSW704074813`). Stable per endpoint. Omitted on success. | |
| message | No | Human-readable explanation. Omitted on success. | |
| available | No | `false` on no-data responses. Omitted on success — branch on `data !== null` if you want a single discriminator. |