Etsy Search by Keyword
Structured Etsy data: send queries. Cursor-paginated, 1 credit per successful call.
Overview
Section titled “Overview”Call GET /api/v2/etsy-search-by-keyword/ with queries. The results are in data.listings; send data.next_cursor back as cursor to get the next page. 2 optional parameters refine the call (see Parameters).
Request
Section titled “Request”curl -G "https://api.scrapier.io/api/v2/etsy-search-by-keyword/" \ -H "X-API-Key: YOUR_API_KEY" \ --data-urlencode "queries=handmade necklace" \ --max-time 210const params = new URLSearchParams({ queries: "handmade necklace" });
const res = await fetch(`https://api.scrapier.io/api/v2/etsy-search-by-keyword/?${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.listings);import requests
resp = requests.get( "https://api.scrapier.io/api/v2/etsy-search-by-keyword/", headers={"X-API-Key": "YOUR_API_KEY"}, params={"queries": "handmade necklace"}, timeout=210,)body = resp.json()if not resp.ok: raise RuntimeError(body.get("error") or body.get("detail"))
print(body["data"]["listings"])curl -X POST "https://api.scrapier.io/api/v2/etsy-search-by-keyword/" \ -H "X-API-Key: YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"queries":"handmade necklace"}' \ --max-time 210Parameters
Section titled “Parameters”| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X-API-Key header | string | yes | — | Your API key from the dashboard. |
queries | string | yes | e.g. handmade necklace | Plain Etsy search keywords. Required on the first call (list -> first only). One Etsy result page (~35-48 organic listings) per 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. |
enable_fallback | boolean | no | true | Web-search-index fallback for page 1 when the Etsy search API is unusable. |
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": { "query": "handmade necklace", "page": 1, "etsy_page": 1, "total_pages": 20, "page_size": 34, "listings": [ { "listing_id": "1772679468", "listing_url": "https://www.etsy.com/listing/1772679468/handmade-sterling-silver-byzantine-chain", "title": "Handmade Sterling Silver Byzantine Chain Necklace - Bali Silver", "image_url": "https://i.etsystatic.com/52961888/r/il/881c8e/6192875617/il_fullxfull.6192875617_g6jb.jpg", "price": 105.04, "currency": "USD", "rating": 4.7, "review_count": 927, "shop_name": "SilverChainArts", "shop_url": "https://www.etsy.com/shop/SilverChainArts", "is_on_sale": true, "has_free_shipping": true, "badges": [], "data_source": "etsySearchApi", "search_query": "handmade necklace", "search_url": "https://www.etsy.com/search?q=handmade+necklace", "page": 1, "position": 1, "scraped_at": "2026-09-26T11:00:24.260Z" } ], "next_cursor": "eyJuIjozNCwibnAiOjIsInAiOjIsInEiOiJoYW5kbWFkZSBuZWNrbGFjZSIsInMiOiJ0YmVvOGMua3huM2ZwLjIzYnhwamguMjM3Y21rMC4yMDRzNDU5LjIzYnpqMmwucmR5ODdzLjIycXU1YTAudGEzcmVoLjIzbWJvMmEuMjE4cjhuYi4yMnowMmVzLjIzcWQ0ZzcuMjJ1NXN4MS4yMXB3bmF6LjIyejJldHQuMjNsaTd4ci4yM29wZDl2LjIwMWFuM2oucXNkaXJ0LjIxMDNtMGkua29haGRxLjIzZDMzMmUucGl2aXI0LjIzZzdsdXMuZ2FldWdjLjIzOXpwYnMuMjJkcnZkNC5vMHJ1NGUucnJuN3J3LjIwNDJ1MGIuMjNtMzQxbC4yM2p2d2w1LjIyM282b2UiLCJ0cCI6MjB9" }}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.listings.
Response fields
Section titled “Response fields”| Field | Type | Example | Description |
|---|---|---|---|
query | string | handmade necklace | — |
page | integer | 1 | — |
etsy_page | integer | 1 | — |
total_pages | integer | 20 | — |
page_size | integer | 34 | — |
listings | array | [1 item] | The results. |
next_cursor | string | eyJuIjozNCwibnAiOjIsInAiOjIsInEiOiJoYW5kbWFkZ… | Pass back as cursor for the next page. null on the last page. |
listings[].listing_id | string | 1772679468 | — |
listings[].listing_url | string | https://www.etsy.com/listing/1772679468/handm… | — |
listings[].title | string | Handmade Sterling Silver Byzantine Chain Neck… | — |
listings[].image_url | string | https://i.etsystatic.com/52961888/r/il/881c8e… | — |
listings[].price | number | 105.04 | — |
listings[].currency | string | USD | — |
listings[].rating | number | 4.7 | — |
listings[].review_count | integer | 927 | — |
listings[].shop_name | string | SilverChainArts | — |
listings[].shop_url | string | https://www.etsy.com/shop/SilverChainArts | — |
listings[].is_on_sale | boolean | true | — |
listings[].has_free_shipping | boolean | true | — |
listings[].badges | array | [] | — |
listings[].data_source | string | etsySearchApi | — |
listings[].search_query | string | handmade necklace | — |
listings[].search_url | string | https://www.etsy.com/search?q=handmade+necklace | — |
listings[].page | integer | 1 | — |
listings[].position | integer | 1 | — |
listings[].scraped_at | string | 2026-09-26T11:00:24.260Z | — |
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-search-by-keyword/";let params = { queries: "handmade necklace" };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.listings ?? [])); if (!data.next_cursor) break; // null = last page params = { cursor: data.next_cursor };}import requests
URL = "https://api.scrapier.io/api/v2/etsy-search-by-keyword/"HEADERS = {"X-API-Key": "YOUR_API_KEY"}params = {"queries": "handmade necklace"}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("listings") 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 |
- Nothing special: send the inputs, read the result.
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 Suggestions — Structured Etsy data: send
queries. Cursor-paginated, 1 credit per successful call. - Etsy Shop Products — Structured Etsy data: send
urls. Cursor-paginated, 1 credit per successful call.