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

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

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

## Overview

Call `GET /api/v2/etsy-shop-products/` with `urls`. The results are in `data.products`; 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-shop-products/" \
  -H "X-API-Key: YOUR_API_KEY" \
  --data-urlencode "urls=https://www.etsy.com/shop/AceElegance" \
  --max-time 210
```

```python
import requests

resp = requests.get(
    "https://api.scrapier.io/api/v2/etsy-shop-products/",
    headers={"X-API-Key": "YOUR_API_KEY"},
    params={"urls": "https://www.etsy.com/shop/AceElegance"},
    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. `https://www.etsy.com/shop/AceElegance` | Etsy shop URL, bare shop name or numeric shop id. Required first call. |
| `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. |
| `sort` | string | no | `most_recent` | One of: `most_recent`, `price_low`, `price_high`, `custom`, `relevance`. Locked in cursor. |
| `currency` | string | no | `USD` | Locked in cursor. |
| `search_query` | string | no | — | In-shop keyword. Locked in cursor. |
| `include_details` | boolean | no | `true` | 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": "AceElegance",
    "shop_name": "AceElegance",
    "shop_id": "27808603",
    "page": 1,
    "page_size": 36,
    "total_results": 183,
    "products": [
      {
        "input_url": "AceElegance",
        "shop_name": "AceElegance",
        "shop_id": "27808603",
        "shop_url": "https://www.etsy.com/shop/AceElegance",
        "shop_total_listings": 183,
        "position": 1,
        "page": 1,
        "id": "1301638116",
        "url": "https://www.etsy.com/listing/1301638116/14k-solid-gold-family-birthstone",
        "title": "14K Solid Gold Family Birthstone Necklace, Birthstone Gift, Christmas Gift, Bridesmaid Gift, Gift for Mom",
        "description": "Silver Birthstone Necklace, Personalized Gifts, 14k Solid Gold Birthstone Jewelry, Family Necklace...",
        "seller": "AceElegance",
        "brand": "AceElegance",
        "price": {
          "current": 14.67,
          "original": 26.67,
          "currency": "USD",
          "discount_percent": 45,
          "display": "$14.67"
        },
        "image_urls": [
          "https://i.etsystatic.com/27808603/r/il/17eff8/4476872409/il_fullxfull.4476872409_hru6.jpg"
        ],
        "availability": "in_stock",
        "free_shipping": true,
        "badges": [
          "FREE shipping"
        ],
        "shipping": {
          "cost": null,
          "estimated_delivery": "Sep 26-Oct 6",
          "accepts_returns": true,
          "accepts_exchanges": true
        },
        "urgency_signal": "In 20+ carts",
        "listing_id": "1301638116",
        "shop_position": 1,
        "canonical_url": "https://www.etsy.com/listing/1301638116",
        "thumbnail_url": "https://i.etsystatic.com/27808603/c/1802/1432/408/0/il/17eff8/4476872409/il_340x270.4476872409_hru6.jpg",
        "is_ad": false,
        "sort": "date_desc",
        "search_query": null,
        "scraped_at": "2026-09-24T13:18:28.883Z"
      }
    ],
    "next_cursor": "eyJpIjoiQWNlRWxlZ2FuY2UiLCJsayI6eyJjdXJyZW5jeSI6IlVTRCJ9LCJuIjozNiwibnAiOjIsInAiOjJ9"
  }
}
```

## Response fields

| Field | Type | Example | Description |
|---|---|---|---|
| `urls` | string | `AceElegance` |  |
| `shop_name` | string | `AceElegance` |  |
| `shop_id` | string | `27808603` |  |
| `page` | integer | `1` |  |
| `page_size` | integer | `36` |  |
| `total_results` | integer | `183` |  |
| `products` | array | `[1 item]` | The results. |
| `next_cursor` | string | `eyJpIjoiQWNlRWxlZ2FuY2UiLCJsayI6eyJjdXJyZW5je…` | Pass back as `cursor` for the next page. `null` on the last page. |
| `products[].input_url` | string | `AceElegance` |  |
| `products[].shop_name` | string | `AceElegance` |  |
| `products[].shop_id` | string | `27808603` |  |
| `products[].shop_url` | string | `https://www.etsy.com/shop/AceElegance` |  |
| `products[].shop_total_listings` | integer | `183` |  |
| `products[].position` | integer | `1` |  |
| `products[].page` | integer | `1` |  |
| `products[].id` | string | `1301638116` |  |
| `products[].url` | string | `https://www.etsy.com/listing/1301638116/14k-s…` |  |
| `products[].title` | string | `14K Solid Gold Family Birthstone Necklace, Bi…` |  |
| `products[].description` | string | `Silver Birthstone Necklace, Personalized Gift…` |  |
| `products[].seller` | string | `AceElegance` |  |
| `products[].brand` | string | `AceElegance` |  |
| `products[].price` | object | `{…}` |  |
| `products[].image_urls` | array | `[1 item]` |  |
| `products[].availability` | string | `in_stock` |  |
| `products[].free_shipping` | boolean | `true` |  |
| `products[].badges` | array | `[1 item]` |  |
| `products[].shipping` | object | `{…}` |  |
| `products[].urgency_signal` | string | `In 20+ carts` |  |
| `products[].listing_id` | string | `1301638116` |  |
| `products[].shop_position` | integer | `1` |  |
| `products[].canonical_url` | string | `https://www.etsy.com/listing/1301638116` |  |
| `products[].thumbnail_url` | string | `https://i.etsystatic.com/27808603/c/1802/1432…` |  |
| `products[].is_ad` | boolean | `false` |  |
| `products[].sort` | string | `date_desc` |  |
| `products[].search_query` | null | `null` |  |
| `products[].scraped_at` | string | `2026-09-24T13:18:28.883Z` |  |

## 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-shop-products/"
HEADERS = {"X-API-Key": "YOUR_API_KEY"}
params = {"urls": "https://www.etsy.com/shop/AceElegance"}
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: `sort`, `currency`, `search_query`, `include_details`. 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.
