---
title: "Search for suggested addresses for the given terms"
method: GET
path: "/v1/properties/_suggest"
tags: ["Properties"]
---

# Search for suggested addresses for the given terms

`GET /v1/properties/_suggest`

Applicable [policies](/docs/latest/support/policies) apply here include APM attribution.

## Query parameters

- `terms` string, required
- `pageSize` integer — the size of the page. Defaults to 15 if unspecified
- `channel` 'All' | 'Residential' | 'Commercial'

## Response `200`

Sample record details

- object[]
  - `address` string
  - `addressComponents` object
    - `unitNumber` string
    - `streetNumber` string
    - `streetName` string
    - `streetType` string
    - `streetTypeLong` string
    - `suburb` string
    - `postCode` string
    - `state` string
  - `id` string
  - `relativeScore` integer

## Other responses

- `400` — Bad request
- `404` — Properties not found
- `500` — Unexpected error

---

[API](https://skmtc.net/domain/apis/domain-public-api.md) · [All operations](https://skmtc.net/domain/apis/domain-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/domain/domain-public-api/revisions/839de6c29cc3/schema)