> 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 Similar Products

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

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

## Overview

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

## Request

```bash
curl -G "https://api.scrapier.io/api/v2/etsy-similar-products/" \
  -H "X-API-Key: YOUR_API_KEY" \
  --data-urlencode "urls=1215970085" \
  --max-time 210
```

```python
import requests

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

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

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. |
| `urls` | string | yes | e.g. `1215970085` | Etsy listing URL or numeric listing id. Required on the first call (list -> first only). 20 products 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. |
| `country` | string | no | `US` | Ship-to country. Locked in cursor. |
| `currency` | string | no | `USD` | Price currency. Locked in cursor. |
| `locale` | string | no | `en-US` | Copy language. Locked in cursor. |
| `include_unavailable` | boolean | no | `false` | Locked in cursor. |
| `expand_similar` | boolean | no | `true` | Similar-of-similar expansion past ~40. 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.products`. Sample from the live catalog, arrays trimmed to 3 items.

```json
{
  "success": true,
  "data": {
    "urls": "1215970085",
    "listing_id": "1215970085",
    "source_listing": {
      "id": "1215970085",
      "url": "https://www.etsy.com/listing/1215970085/custom-air-freshener-picture-air",
      "title": "Custom Air Freshener, Picture Air Freshener, ...",
      "seller": "TheFreshener",
      "seller_id": "35332887"
    },
    "page": 1,
    "page_size": 20,
    "products": [
      {
        "input_url": "1215970085",
        "source_listing_id": "1215970085",
        "position": 1,
        "depth": 1,
        "similar_to_listing_id": "1215970085",
        "id": "4557154966",
        "url": "https://www.etsy.com/listing/4557154966/custom-air-freshener-picture-air",
        "title": "Custom Air Freshener, Picture Air Freshener, Cute Car Accessories, Photo Freshener, Car Freshies, Car Decor",
        "description": "Custom Face Cut Car Air Freshener. Versatile Scent Selection...",
        "seller": "DidiDecous",
        "brand": null,
        "price": {
          "current": 11.98,
          "original": 23.96,
          "currency": "USD"
        },
        "rating": {
          "average": 4.66,
          "count": 47
        },
        "image_urls": [
          "https://i.etsystatic.com/61480419/r/il/17ef7d/8372827043/il_fullxfull.8372827043_mdpo.jpg"
        ],
        "availability": "in_stock",
        "reviews_count": 47,
        "ext": {
          "seller_id": "61480419",
          "available_quantity": 2989,
          "etsy": {
            "is_handmade": true,
            "is_bestseller": false,
            "is_made_to_order": true,
            "when_made": "made_to_order",
            "discount_percent": 50,
            "free_shipping": false,
            "ships_from_country": "US",
            "favorites": 1,
            "tags": [
              "car freshener funny",
              "cute car air fresh"
            ],
            "materials": [
              "Paper"
            ],
            "category": {
              "id": 1895,
              "name": "Car Accessories",
              "path": "electronics_and_accessories.car_parts_and_accessories.car_accessories"
            },
            "shop": {
              "shop_id": "61480419",
              "name": "DidiDecous",
              "url": "https://www.etsy.com/shop/DidiDecous",
              "rating_average": 4.66,
              "rating_count": 47,
              "sold_count": 356,
              "active_listing_count": 71,
              "country_code": "US",
              "is_open": true
            },
            "language": "en-US",
            "created_at": "2026-08-17T09:50:20Z",
            "updated_at": "2026-09-01T01:22:41Z"
          }
        },
        "source_listing": {
          "id": "1215970085",
          "url": "https://www.etsy.com/listing/1215970085/custom-air-freshener-picture-air",
          "title": "Custom Air Freshener, Picture Air Freshener, ...",
          "seller": "TheFreshener",
          "seller_id": "35332887"
        },
        "scraped_at": "2026-09-24T13:17:36.454Z"
      }
    ],
    "next_cursor": "eyJpIjoiMTIxNTk3MDA4NSIsImxrIjp7ImNvdW50cnkiOiJVUyIsImN1cnJlbmN5IjoiVVNEIn0sIm8iOjIwLCJwIjoyfQ"
  }
}
```

## Response fields

| Field | Type | Example | Description |
|---|---|---|---|
| `urls` | string | `1215970085` |  |
| `listing_id` | string | `1215970085` |  |
| `source_listing` | object | `{…}` |  |
| `page` | integer | `1` |  |
| `page_size` | integer | `20` |  |
| `products` | array | `[1 item]` | The results. |
| `next_cursor` | string | `eyJpIjoiMTIxNTk3MDA4NSIsImxrIjp7ImNvdW50cnkiO…` | Pass back as `cursor` for the next page. `null` on the last page. |
| `products[].input_url` | string | `1215970085` |  |
| `products[].source_listing_id` | string | `1215970085` |  |
| `products[].position` | integer | `1` |  |
| `products[].depth` | integer | `1` |  |
| `products[].similar_to_listing_id` | string | `1215970085` |  |
| `products[].id` | string | `4557154966` |  |
| `products[].url` | string | `https://www.etsy.com/listing/4557154966/custo…` |  |
| `products[].title` | string | `Custom Air Freshener, Picture Air Freshener, …` |  |
| `products[].description` | string | `Custom Face Cut Car Air Freshener. Versatile …` |  |
| `products[].seller` | string | `DidiDecous` |  |
| `products[].brand` | null | `null` |  |
| `products[].price` | object | `{…}` |  |
| `products[].rating` | object | `{…}` |  |
| `products[].image_urls` | array | `[1 item]` |  |
| `products[].availability` | string | `in_stock` |  |
| `products[].reviews_count` | integer | `47` |  |
| `products[].ext` | object | `{…}` |  |
| `products[].source_listing` | object | `{…}` |  |
| `products[].scraped_at` | string | `2026-09-24T13:17:36.454Z` |  |

## 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-similar-products/"
HEADERS = {"X-API-Key": "YOUR_API_KEY"}
params = {"urls": "1215970085"}
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("products") 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: `country`, `currency`, `locale`, `include_unavailable`, `expand_similar`. 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 Search Suggestions](https://docs.scrapier.io/api-reference/etsy/etsy-search-suggestions.md): Structured Etsy data: send `queries`. Cursor-paginated, 1 credit per successful call.
