Etsy Similar Products
Structured Etsy data: send urls. Cursor-paginated, 1 credit per successful call.
Overview
Section titled “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
Section titled “Request”curl -G "https://api.scrapier.io/api/v2/etsy-similar-products/" \ -H "X-API-Key: YOUR_API_KEY" \ --data-urlencode "urls=1215970085" \ --max-time 210const params = new URLSearchParams({ urls: "1215970085" });
const res = await fetch(`https://api.scrapier.io/api/v2/etsy-similar-products/?${params}`, { headers: { "X-API-Key": "YOUR_API_KEY" }, signal: AbortSignal.timeout(210_000),});const body = await res.json();if (!res.ok) throw new Error(body.error ?? body.detail ?? `HTTP ${res.status}`);
console.log(body.data.products);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"])curl -X POST "https://api.scrapier.io/api/v2/etsy-similar-products/" \ -H "X-API-Key: YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"urls":"1215970085"}' \ --max-time 210Parameters
Section titled “Parameters”| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X-API-Key header | string | yes | — | Your API key from the dashboard. |
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 |
Advanced
| Name | Type | Default | Description |
|---|---|---|---|
use_proxy | boolean | true | Route the request through Scrapier's residential proxy pool. Default: true. Leave as is unless support tells you otherwise. |
raw_data | boolean | 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
Section titled “Response”{ "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" }}Bad input. The exact message varies by endpoint.
{ "success": false, "error": "…"}Balance below the endpoint’s price.
{ "error": "Insufficient credits. Buy more to scrape more.", "balance": 1, "required": 2}Invalid or unknown API key.
{ "detail": "Authentication service unavailable or invalid API key."}Throttled — wait for Retry-After.
{ "detail": "Request was throttled. Expected available in N seconds."}Sample from the live catalog; arrays trimmed to 3 items. Results are in data.products.
Response fields
Section titled “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
Section titled “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. More in Pagination.
const url = "https://api.scrapier.io/api/v2/etsy-similar-products/";let params = { urls: "1215970085" };const items = [];
for (let page = 0; page < 10; page++) { // each page is one billed call const res = await fetch(`${url}?${new URLSearchParams(params)}`, { headers: { "X-API-Key": "YOUR_API_KEY" }, signal: AbortSignal.timeout(210_000), }); const body = await res.json(); if (!res.ok) throw new Error(body.error ?? body.detail ?? `HTTP ${res.status}`); const data = body.data; items.push(...(data.products ?? [])); if (!data.next_cursor) break; // null = last page params = { cursor: data.next_cursor };}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
Section titled “Errors”Failed calls are free. Branch on the HTTP status and read the message from error (or detail). Full details in Errors.
| Status | Meaning | Retry? | Charged? |
|---|---|---|---|
400 | Bad or missing input. | No — fix the params | No |
401 / 403 | Missing, invalid or revoked API key. | No — fix the key | No |
402 | Out of credits (body has balance). | No — top up | No |
404 | Unknown endpoint slug. | No — check the slug | No |
429 / 503 | Busy or throttled. | Yes — after Retry-After | No |
5xx | Target site or upstream failure, or timeout. | Yes — with backoff | No |
- Locked into the cursor:
country,currency,locale,include_unavailable,expand_similar. Set them on the first call; later pages reuse them.
Related
Section titled “Related”- Etsy Product Info by Url — Structured Etsy data: send
urls. Single lookup, 1 credit per successful call. - Etsy Product Reviews — Structured Etsy data: send
urls. Cursor-paginated, 1 credit per successful call. - Etsy Search by Keyword — Structured Etsy data: send
queries. Cursor-paginated, 1 credit per successful call. - Etsy Search Suggestions — Structured Etsy data: send
queries. Cursor-paginated, 1 credit per successful call.