> 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`.

# Etsy Search Suggestions

Structured Etsy data: send `queries`. Cursor-paginated, 1 credit per successful call.

`GET|POST https://api.scrapier.io/api/v2/etsy-search-suggestions/` · 1 credit per successful call · Cursor-paginated

## Overview

Call `GET /api/v2/etsy-search-suggestions/` with `queries`. The results are in `data.suggestions`; send `data.next_cursor` back as `cursor` to get the next page. 5 optional parameters refine the call (see Parameters).

## Request

```bash
curl -G "https://api.scrapier.io/api/v2/etsy-search-suggestions/" \
  -H "X-API-Key: YOUR_API_KEY" \
  --data-urlencode "queries=leather" \
  --max-time 210
```

```python
import requests

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

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

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. `leather` | Partial Etsy search text. Required on the first call. 20 suggestions per page. |
| `cursor` | string | no | — | Pagination cursor returned in the previous response's `next_cursor`. Pass it back unchanged to fetch the next page. When `next_cursor` is null, you have reached the last page. |
| `locale` | string | no | `en-US` | Etsy suggestion language. One of: `en-US`, `en-GB`, `en-CA`, `en-AU`, `en-IN`, `de`, `fr`, `es`, `it`, `nl`, `pt`, `pl`, `sv`, `ja`, `ru`. Locked in cursor. |
| `country` | string | no | `US` | ISO-2 region. Locked in cursor. |
| `expand` | boolean | no | `true` | Alphabet expansion for pages beyond the base list. Locked in cursor. |
| `expansion_alphabet` | string | no | — | Blank = a-z0-9. Locked in cursor. |
| `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.suggestions`. Sample from the live catalog, arrays trimmed to 3 items.

```json
{
  "success": true,
  "data": {
    "queries": "leather",
    "locale": "en-US",
    "country": "US",
    "page": 1,
    "page_size": 20,
    "suggestions": [
      {
        "keyword": "leather",
        "position": 1,
        "query": "leather journal",
        "search_types": [],
        "search_type_names": [],
        "categories": [],
        "source": "v3+legacy",
        "seed": "leather",
        "depth": 0,
        "locale": "en-US",
        "country": "US",
        "search_url": "https://www.etsy.com/search?q=leather+journal",
        "scraped_at": "2026-09-24T13:07:55.516Z"
      },
      {
        "keyword": "leather",
        "position": 2,
        "query": "leather",
        "search_types": [],
        "search_type_names": [],
        "categories": [],
        "source": "v3",
        "seed": "leather",
        "depth": 0,
        "locale": "en-US",
        "country": "US",
        "search_url": "https://www.etsy.com/search?q=leather",
        "scraped_at": "2026-09-24T13:07:55.516Z"
      }
    ],
    "next_cursor": "eyJpIjoibGVhdGhlciIsImxrIjp7fSwicCI6MiwicyI6WyJiMmRmNDA1OCIsIjc5YWNmNTM0Il19"
  }
}
```

## Response fields

| Field | Type | Example | Description |
|---|---|---|---|
| `queries` | string | `leather` |  |
| `locale` | string | `en-US` |  |
| `country` | string | `US` |  |
| `page` | integer | `1` |  |
| `page_size` | integer | `20` |  |
| `suggestions` | array | `[2 items]` | The results. |
| `next_cursor` | string | `eyJpIjoibGVhdGhlciIsImxrIjp7fSwicCI6MiwicyI6W…` | Pass back as `cursor` for the next page. `null` on the last page. |
| `suggestions[].keyword` | string | `leather` |  |
| `suggestions[].position` | integer | `1` |  |
| `suggestions[].query` | string | `leather journal` |  |
| `suggestions[].search_types` | array | `[]` |  |
| `suggestions[].search_type_names` | array | `[]` |  |
| `suggestions[].categories` | array | `[]` |  |
| `suggestions[].source` | string | `v3+legacy` |  |
| `suggestions[].seed` | string | `leather` |  |
| `suggestions[].depth` | integer | `0` |  |
| `suggestions[].locale` | string | `en-US` |  |
| `suggestions[].country` | string | `US` |  |
| `suggestions[].search_url` | string | `https://www.etsy.com/search?q=leather+journal` |  |
| `suggestions[].scraped_at` | string | `2026-09-24T13:07:55.516Z` |  |

## Pagination

Pass `data.next_cursor` back as `cursor` until it is `null`. Required inputs are ignored once a cursor is sent. Each page is one billed call.

```python
import requests

URL = "https://api.scrapier.io/api/v2/etsy-search-suggestions/"
HEADERS = {"X-API-Key": "YOUR_API_KEY"}
params = {"queries": "leather"}
items = []

for _ in range(10):  # each page is one billed call
    resp = requests.get(URL, headers=HEADERS, params=params, timeout=210)
    resp.raise_for_status()
    data = resp.json()["data"]
    items.extend(data.get("suggestions") or [])
    if not data.get("next_cursor"):  # None = last page
        break
    params = {"cursor": data["next_cursor"]}
```

## 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

- Locked into the cursor: `locale`, `country`, `expand`, `expansion_alphabet`. Set them on the first call; later pages reuse them.

## Related

- [Etsy Product Info by Url](https://docs.scrapier.io/api-reference/etsy/etsy-product-info-by-url.md): Structured Etsy data: send `urls`. Single lookup, 1 credit per successful call.
- [Etsy Product Reviews](https://docs.scrapier.io/api-reference/etsy/etsy-product-reviews.md): Structured Etsy data: send `urls`. Cursor-paginated, 1 credit per successful call.
- [Etsy Search by Keyword](https://docs.scrapier.io/api-reference/etsy/etsy-search-by-keyword.md): Structured Etsy data: send `queries`. Cursor-paginated, 1 credit per successful call.
- [Etsy Shop Products](https://docs.scrapier.io/api-reference/etsy/etsy-shop-products.md): Structured Etsy data: send `urls`. Cursor-paginated, 1 credit per successful call.
