LOCATIONS
Search suburbs
Search Australian postcode locality reference data. Not a full address-validation service.
/api/v1/locations/suburbs1 credit / callParameters
| Parameter | Type | Description |
|---|---|---|
q | string | Suburb or postcode prefix; max100characters. |
state | string | Optional state code. |
page | integer | Page 1–20. |
per_page | integer | Records per page 1–50. |
MAKE IT YOUR OWN
Build a request
Edit the parameters to generate a ready-to-use code example. No request runs until you select Send request. Python uses the requests package; PHP requires cURL; JavaScript examples run on your backend with Node.js 18 or later.
Example response
Illustrative structure, not a live property record. Fields may be null when the source has not supplied a value.
{
"data": [
{
"suburb": "BRISBANE",
"postcode": "4000",
"state": "QLD"
}
],
"meta": {
"example": true,
"credit_cost": 1
}
}Also available through MCP
Use the listingdata_suburbs tool with the same documented inputs. Calls share your REST API credit balance and rate limits. Connect your MCP client →
Errors and retrying
| Status | Meaning | Recommended handling |
|---|---|---|
400 / 422 | Invalid or unsupported parameters. | Correct the input using the error response. |
401 / 403 | Invalid key or ineligible account. | Check key status and account verification. |
404 | The requested record is not available. | Check the ID; do not infer a property’s status. |
402 | Monthly credit allowance exhausted. | Wait for the next UTC calendar month. |
429 | Minimum interval or daily request allowance exceeded. | Honour Retry-After and reset details. |
503 | A required data service is unavailable. | Back off and retry later. Service-side charges are refunded. |
Property descriptions, internal search price bands and agent contact email or telephone numbers are never included. Source status and timestamps describe observations, not a guarantee of current availability. Future-dated source times are withheld. A record’s indexed_at is its last public index write; use the coverage endpoint for the last completed refresh cycle. Read the field policy.