---
title: "Search suburbs by name"
method: GET
path: "/v1/rental/search"
tags: ["Rental Prices"]
---

# Search suburbs by name

`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`

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.

## Query parameters

- `q` string, required: Suburb name (partial match)
- `state` string, nullable: Optional state code to scope the search (e.g. VIC). Omit to search all states.
- `limit` integer

## Headers

- `X-API-Key` string, required

## Response `200`

Successful Response

- unknown

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/aristocles/apis/aristocles-data-api.md) · [All operations](https://skmtc.dev/aristocles/apis/aristocles-data-api/llms.txt) · [OpenAPI document](https://skmtc.dev/aristocles/apis/aristocles-data-api/revisions/4ca3fbb73c59?raw)