suburbs_list
List Australian suburbs (SALs). Always returns {suburb, state}
per row so SAL-name collisions across states are unambiguous.
With no filter you get the first 1000 suburbs alphabetically (browser-renderable preview). Pass any of the filters to narrow: state / lga / sa4 / sa3 / postcode / q (name search). Filters combine (AND). Flat cost regardless of how many rows come back.
Name search (q) is typo-tolerant. It tries an exact match, then
substring, then a fuzzy near-miss, and returns match
(exact / contains / fuzzy) and score on every row so you can
see which happened.
Always tell the user which suburb you resolved to, and its state,
before quoting numbers for it. A fuzzy match is a suggestion, not a
confirmation — rokeby is one letter from Kokeby in Western Australia
and Rokeby exists in both Tasmania and Victoria. If more than one
candidate is plausible, ask rather than pick.
When q is combined with state, the state is a preference, not a
filter: in-state candidates rank first, but a suburb of that name in
another state is still returned rather than hidden, so a near-miss
becomes "Seaview is in Victoria, not Tasmania" instead of "no data".
Every other filter stays a strict AND.
Price: 3¢ per call.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Suburb-name search. Matches exactly, then by substring, then by fuzzy near-miss so a typo still resolves ('devenport' -> Devonport). Each row comes back with `match` and `score` saying how it was found. | |
| lga | No | Filter by Local Government Area name. | |
| sa3 | No | Filter by SA3 name. | |
| sa4 | No | Filter by SA4 name. | |
| state | No | Filter by state / territory (e.g. NSW, VIC, 'New South Wales'). | |
| postcode | No | Filter by 4-digit postcode (POA). |
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. |