---
title: "GET /suggest"
method: GET
path: "/suggest"
tags: ["suggest"]
---

# GET /suggest

`GET /suggest`

## Query parameters

- `q` string, required
- `currentState` string
- `match_ids` boolean

## Response `200`

successful operation

- SuggestMatches
  - `matches` SuggestMatch[]
    - `property` PropertyIdentifier
      - `id` integer
      - `matchlevel` 'suburb' | 'street' | 'property'
      - `location` Point
        - `lat` number, double
        - `lon` number, double
      - `parent` boolean
      - `_self` string
    - `street` StreetIdentifier
      - `id` string
    - `suburb` SuburbIdentifier
      - `id` string
      - `_self` string
    - `type` 'property' | 'street' | 'suburb' | 'typeahead'
    - `display` string
    - `legalDescription` string
    - `address` Address
      - `street` string
      - `unit` string
      - `level` string
      - `lot` string
      - `streetNumber` string
      - `streetAddress` string
      - `locality` string
      - `streetLocation` string
      - `state` string
      - `postcode` string
      - `countryCode` string
      - `streetName` string
      - `streetSuffix` string
      - `streetType` string
      - `lga` string
    - `alternativeAddresses` Address[]
      - `street` string
      - `unit` string
      - `level` string
      - `lot` string
      - `streetNumber` string
      - `streetAddress` string
      - `locality` string
      - `streetLocation` string
      - `state` string
      - `postcode` string
      - `countryCode` string
      - `streetName` string
      - `streetSuffix` string
      - `streetType` string
      - `lga` string
  - `disclaimer` string
  - `messages` Message[]
    - `code` integer
    - `text` string

---

[API](https://skmtc.net/pricefinder/apis/pricefinder-api-v1-13-1.md) · [All operations](https://skmtc.net/pricefinder/apis/pricefinder-api-v1-13-1/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pricefinder/pricefinder-api-v1-13-1/revisions/10efa1470b1d/schema)