> Documentation index: https://docs.scrapier.io/llms.txt
> Auth: header `X-API-Key: <key>` · Base: https://api.scrapier.io/api/v2 · Synchronous; paginate with `cursor` ← `data.next_cursor`.

# Amazon Keyword Suggestions

Get Amazon search-box autocomplete suggestions for a keyword in one call.

`GET|POST https://api.scrapier.io/api/v2/amazon-keyword-suggestion/` · 1 credit per successful call · Single lookup

## Overview

Send a keyword in `queries` and get the suggestions Amazon's search box offers for it. The `result` object holds the looked-up `query` and a `suggestions` list; each suggestion carries the suggested search text in `item`.

This is a single lookup: `next_cursor` is always `null`.

## Use cases

- Find long-tail keywords for product listings and ads.
- Seed an Amazon search crawl with related terms.
- See how shoppers phrase searches around a product.

## Request

```bash
curl -G "https://api.scrapier.io/api/v2/amazon-keyword-suggestion/" \
  -H "X-API-Key: YOUR_API_KEY" \
  --data-urlencode "queries=iphone" \
  --max-time 210
```

```python
import requests

resp = requests.get(
    "https://api.scrapier.io/api/v2/amazon-keyword-suggestion/",
    headers={"X-API-Key": "YOUR_API_KEY"},
    params={"queries": "iphone"},
    timeout=210,
)
body = resp.json()
if not resp.ok:
    raise RuntimeError(body.get("error") or body.get("detail"))

print(body["data"]["result"])
```

POST with a JSON body works too (same parameters; the body is merged over the query string).

## Parameters

| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| `X-API-Key` (header) | string | yes | — | Your API key. |
| `queries` | string | yes | e.g. `iphone` | Search keyword. Lookup endpoint -- next_cursor null. |
| `max_items` | integer | no | `50` | Maximum number of items to return. The catalog has no description for this parameter yet; the default is usually right. |
| `use_proxy` | boolean | no | `true` | Route the request through Scrapier's residential proxy pool. Default: `true`. Leave as is unless support tells you otherwise. |
| `raw_data` | boolean | no | `false` | When true, the response carries the full raw upstream payload(s) the scraper received (GraphQL / JSON API bodies, HTML, embedded JSON-LD -- exactly as the platform returned them) under `raw_responses`, in place of the formatted items. When false (default) you get the formatted output. Pagination (`cursor` / `next_cursor`) works the same in both modes. |

## Response

HTTP 200. Results are in `data.result`. Sample from the live catalog, arrays trimmed to 3 items.

```json
{
  "success": true,
  "data": {
    "queries": "laptop",
    "result": {
      "query": "laptop",
      "success": true,
      "suggestions": [
        {
          "keyword": "laptop",
          "type": "suggestion",
          "item": "laptop"
        },
        {
          "keyword": "laptop",
          "type": "suggestion",
          "item": "laptop stand"
        },
        {
          "keyword": "laptop",
          "type": "suggestion",
          "item": "laptop cooling pad"
        }
      ]
    },
    "next_cursor": null
  }
}
```

## Response fields

| Field | Type | Example | Description |
|---|---|---|---|
| `queries` | string | `laptop` |  |
| `result` | object | `{…}` | The keyword that was looked up and its suggestions. |
| `next_cursor` | null | `null` | Pass back as `cursor` for the next page. `null` on the last page. |
| `result.query` | string | `laptop` |  |
| `result.success` | boolean | `true` |  |
| `result.suggestions` | array | `[3 items]` | Autocomplete entries; each one has `keyword`, `type` and `item` (the suggested search text). |

## Pagination

Single lookup: everything comes back in one call and `next_cursor` is always `null`.

## Errors

Failed calls are free. Branch on HTTP status; the message is in `error` (or `detail`). See https://docs.scrapier.io/errors.md

- **400** Bad input. The exact message varies by endpoint. `{"success":false,"error":"…"}`
- **402** Balance below the endpoint's price. `{"error":"Insufficient credits. Buy more to scrape more.","balance":1,"required":2}`
- **403** Invalid or unknown API key. `{"detail":"Authentication service unavailable or invalid API key."}`
- **429** Throttled — wait for Retry-After. `{"detail":"Request was throttled. Expected available in N seconds."}`
- **404** unknown slug · **503** busy (retry after `Retry-After`) · **5xx** upstream failure or timeout (retry with backoff).

## Notes

- `queries` takes one keyword per call.
- `max_items` has no description in the catalog yet; its default is 50.
- The response data carries its own `success` field from the scraper. The outer `success` is what counts: an HTTP 200 with outer `success: true` is billed, even if the inner field says otherwise.

## Related

- [Amazon Search](https://docs.scrapier.io/api-reference/amazon/amazon-search.md): Search Amazon by keyword and get product results with price, rating and position, with marketplace and sort order options.
- [Amazon Products](https://docs.scrapier.io/api-reference/amazon/amazon-product.md): Search Amazon by keyword or URL and get product listings, or send a product URL to get that single product.
