---
title: "Autocomplete"
method: GET
path: "/autocomplete/{instancekey}"
tags: ["Autocomplete"]
deprecated: true
---

# Autocomplete

`GET /autocomplete/{instancekey}`

> **Deprecated.**

Deprecated. This endpoint has been replaced by Suggestions. For all new implementations we strongly recommend using the Suggestions endpoints to receive the latest updates, get category suggestions and more. Please review the Suggestions documentation at https://docs.tweakwise.com/reference/suggestions for integration details. Service that returns product results and search suggestions based on a search term. This service can be called as soon as the user begins to type a search term.

## Path parameters

- `instancekey` string, required

## Query parameters

- `tn_q` string, required
- `tn_cid` string
- `tn_items` boolean
- `tn_suggestions` boolean
- `tn_instant` boolean
- `tn_maxresults` number
- `tn_lang` string
- `tn_keyboard` string
- `tn_parameters` string
- `tn_parameters_except` string
- `tn_options` string[]

## Headers

- `TWN-Source` string

## Response `200`

Collection of autocomplete results

- Autocomplete
  - `items` AutocompleteItem[]
    - `visualproperties` Visualproperties
      - `colspan` integer — The number of columns the item takes up.
      - `rowspan` integer — The number of rows the item takes up.
    - `type` string — Type of item
    - `itemno` string — Unique item number
    - `title` string — Title of item
    - `price` number, double — Price of item
    - `brand` string — Brand of item
    - `url` string — URL of item
    - `image` string — Image URL of item
    - `attributes` AutocompleteItemAttribute[]
      - `name` string — Name of an attribute
      - `values` string[] — Values of an attribute
  - `suggestions` AutocompleteSuggestion[]
    - `title` string — Title of suggestion
  - `instantsearch` AutocompleteInstantSearch
    - `isactive` boolean — Indicates if instant search is active
    - `searchterm` string — Search term for instant search

## Other responses

- `401` — Invalid instancekey supplied

---

[API](https://skmtc.net/tweakwise/apis/frontend-api.md) · [All operations](https://skmtc.net/tweakwise/apis/frontend-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tweakwise/frontend-api/revisions/9bd1e2b3633f/schema)