---
title: "Get IKEA search-box typeahead suggestions"
method: GET
path: "/ikea/suggest"
tags: ["IKEA"]
---

# Get IKEA search-box typeahead suggestions

`GET /ikea/suggest`

## Request

- Base URL: `https://api.crawlora.net/api/v1`
- URL: `https://api.crawlora.net/api/v1/ikea/suggest`
- Auth: API key in header `x-api-key`

Returns IKEA's own search-box typeahead result for a partial or full query: suggested query completions with their own match counts, plus a small number of top matching products. A query with no matches returns a clean empty response.

## Query parameters

- `q` string, required
- `country` string
- `language` string
- `size` integer

## Headers

- `x-api-key` string, required

## Response `200`

OK

- IkeaSuggestResponseDoc
  - `code` integer
  - `data` IkeaSuggestResponse
    - `count` integer
    - `country` string
    - `fetched_at` string
    - `language` string
    - `products` IkeaProductSummary[]
      - `colors` IkeaColor[]
        - `hex` string
        - `id` string
        - `name` string
      - `filter_class` string: FilterClass is IKEA's own product-type slug, e.g. "desks" -- usable as a coarse category signal, though it is not currently accepted back as a category-browse filter by this endpoint (see this package's doc comment).
      - `image_url` string
      - `item_no` string
      - `measure_text` string
      - `name` string
      - `price` IkeaPrice
        - `currency_code` string
        - `current` number
        - `discount_amount` number
        - `discount_percentage` number
        - `formatted` string
        - `previous` number
        - `previous_formatted` string
        - `tag` string: Tag is IKEA's own price-badge code, e.g. "FAMILY_PRICE" for an IKEA Family member price. TagText is its human-readable label, e.g. "IKEA Family price".
        - `tag_text` string
        - `valid_from` string
        - `valid_to` string
      - `product_url` string
      - `rating` IkeaRating
        - `count` integer
        - `value` number
      - `type_name` string
      - `valid_design` string: ValidDesign is IKEA's own color/finish descriptor for this exact item, e.g. "white" or "black-brown" -- the design this specific item number represents, as opposed to Colors below (every color swatch shown for the product family).
      - `variant_count` integer: VariantCount is the total number of other purchasable size/color/design options this product has, which may exceed len(Variants) -- the search endpoint's own gprDescription block does not always enumerate every variant.
      - `variants` IkeaVariant[]
        - `image_url` string
        - `item_no` string
        - `name` string
        - `price` IkeaPrice
          - `currency_code` string
          - `current` number
          - `discount_amount` number
          - `discount_percentage` number
          - `formatted` string
          - `previous` number
          - `previous_formatted` string
          - `tag` string: Tag is IKEA's own price-badge code, e.g. "FAMILY_PRICE" for an IKEA Family member price. TagText is its human-readable label, e.g. "IKEA Family price".
          - `tag_text` string
          - `valid_from` string
          - `valid_to` string
        - `product_url` string
        - `rating` IkeaRating
          - `count` integer
          - `value` number
        - `type_name` string
        - `valid_design` string
    - `query` string
    - `source_url` string
    - `suggestions` IkeaRelatedSearch[]
      - `count` integer
      - `text` string
  - `msg` string

## Other responses

- `400`: Bad Request
- `429`: Too Many Requests
- `503`: Service Unavailable

---

[API](https://skmtc.dev/crawlora/apis/crawlora-api.md) · [All operations](https://skmtc.dev/crawlora/apis/crawlora-api/llms.txt) · [OpenAPI document](https://skmtc.dev/crawlora/apis/crawlora-api/revisions/0497899e2016?raw)