---
title: "Suggest Shop.app searches"
method: GET
path: "/shop-app/suggestions"
tags: ["Shop.app"]
---

# Suggest Shop.app searches

`GET /shop-app/suggestions`

## Request

- Base URL: `https://api.crawlora.net/api/v1`
- URL: `https://api.crawlora.net/api/v1/shop-app/suggestions`
- Auth: API key in header `x-api-key`

Returns Shop.app autocomplete suggestions for the required `query`. `limit` defaults to 10 and is capped at 20. Each suggestion is either a search query or a shop, with its `text`, `type`, URL and, for shops, the shop handle, name, rating and image.

## Query parameters

- `query` string, required
- `limit` integer

## Headers

- `x-api-key` string, required

## Response `200`

OK

- ShopappSuggestionsResponseDoc
  - `code` integer
  - `data` ShopappSuggestResponse
    - `limit` integer: Maximum number of suggestions requested.
    - `query` string: Partial search text that suggestions were requested for.
    - `suggestions` ShopappSuggestionItem[]: Search suggestions returned for the text.
      - `image` string: URL of the shop logo. Set for `shop` suggestions.
      - `rating` number: Average shopper rating of the shop. Set for `shop` suggestions.
      - `shop_handle` string: Shop.app handle of the shop. Set for `shop` suggestions.
      - `shop_id` string: Shop.app ID of the shop. Set for `shop` suggestions.
      - `shop_name` string: Name of the shop. Set for `shop` suggestions.
      - `text` string: Suggested search text or shop name.
      - `type` string: Kind of suggestion: `query` or `shop`.
      - `url` string: Shop.app URL of the search results or shop page for the suggestion.
  - `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/028417aa35bb?raw)