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

# GET /suggest/typeahead

`GET /suggest/typeahead`

## Request

- Base URL: `https://api.pricefinder.com.au/v1`
- URL: `https://api.pricefinder.com.au/v1/suggest/typeahead`
- Auth: none declared

## Query parameters

- `q` string, required

## Response `200`

successful operation

- TypeAheadSuggestions
  - `disclaimer` string
  - `messages` Message[]
    - `code` integer
    - `text` string
  - `suggestions` TypeAheadSuggestion[]
    - `legacyPropertyId` integer
    - `unitNumber` string
    - `streetNumber` string
    - `streetName` string
    - `streetType` string
    - `streetTypeLong` string
    - `suburb` string
    - `postcode` string
    - `state` string
    - `id` string
    - `urlSlug` string
    - `pdsId` integer
    - `address` string
    - `relativeScore` integer
    - `score` number, double
    - `additionalProperties` object

## Changes

- **2026-08-04** `8f54f57f359a`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/pricefinder/apis/pricefinder-api-v1-13-1/changes/suggest/typeahead/get.md)

---

[API](https://skmtc.dev/pricefinder/apis/pricefinder-api-v1-13-1.md) - [All operations](https://skmtc.dev/pricefinder/apis/pricefinder-api-v1-13-1/llms.txt) - [OpenAPI document](https://skmtc.dev/pricefinder/apis/pricefinder-api-v1-13-1/revisions/baec3d04c6d9?raw)
