Rental Prices

Search suburbs by name

Search suburbs by partial name across Australia. Returns the latest all-properties median rent for each match. Pass state to scope the search to one state, or omit it to search everywhere.

get/v1/rental/search

Request

  • Base URL: https://api.aristocles.com.au (the document declares no server; this is the origin it was published from)
  • URL: https://api.aristocles.com.au/v1/rental/search
  • Auth: none declared. Required headers: X-API-Key

Query parameters

qstring required

Suburb name (partial match)

statestring nullable

Optional state code to scope the search (e.g. VIC). Omit to search all states.

limitinteger

Headers

X-API-Keystring required

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 2 revisions of this API.