Search Etsy listings

Try in Playground

Read one Etsy search results page for a query: the ordered organic listing IDs (up to 48), a listing card for every organic result with shop, prices, discount, rating and badges, every promoted listing card and the total page count. organic_results_partially_embedded marks a page whose remaining organic IDs came back without card data.

GET/v1/etsy/searchx-api-key

Headers

Get your API key

x-api-keystringrequiredheader

Your ScrapeAtlas customer key. Create one on /account/ and set SCRAPEATLAS_API_KEY.

Query parameters

querystringrequiredquery

Search text (1-200 characters).

min 1 chars · max 200 chars

Exampleexample query

pageintegerdefault: 1query

Results page starting at 1.

default: 1 · 1 – 250

sortenumdefault: "most_relevant"query

most_relevant (default), price_low, price_high, highest_reviews or most_recent.

one of: most_relevant, price_low, price_high, highest_reviews, most_recent · default: "most_relevant"

min_pricenumberquery

Optional.

0 – 1000000

max_pricenumberquery

Optional.

0 – 1000000

currencyenumdefault: "USD"query

Display currency pinned through Etsy's own locale override (default USD). One of the 30 currencies Etsy offers; language and region stay en-US / US.

one of: AUD, BRL, CAD, CHF, CNY, CZK, DKK, EUR, GBP, HKD, HUF, IDR, ILS, INR, JPY, MAD, MXN, MYR, NOK, NZD, PHP, PLN, SEK, SGD, THB, TRY, TWD, USD, VND, ZAR · default: "USD"

Response fields

requestIdstring

Request correlation UUID.

Upstream document reads (a DataDome device check adds one; sorted or deep pages add the page-one primer), decoded bytes delivered to the parser and elapsed milliseconds.

accounting.upstreamRequestsinteger

Always included.

≥ 0

accounting.responseBytesinteger

Always included.

≥ 0

accounting.durationMsnumber

Always included.

≥ 0

successboolean

True when usable public data is returned; inspect status and coverage for omissions.

statusenum

success, partial, failed or challenged. HTTP 200 can be partial.

one of: success, partial

sourceUrlstring

Canonical public Etsy URL the response describes, without locale or tracking parameters.

absolute HTTPS URL

fetchedAtstring

UTC retrieval timestamp.

Complete means every supported field on this page was read; warnings name each omission or cap. It never implies the shop's or query's full catalogue.

coverage.sourceenum

Always included.

one of: public_page, public_api

coverage.completeboolean

Always included.

coverage.warningsenum[]

Always included.

querystring

Search text (1-200 characters).

sortenum

most_relevant (default), price_low, price_high, highest_reviews or most_recent.

one of: most_relevant, price_low, price_high, highest_reviews, most_recent

pageinteger

Results page starting at 1.

≥ 1

totalPagesintegernullable

Always included.

nextPageintegernullable

Always included.

listingIdsstring[]

Organic result listing IDs in ranking order.

up to 48 items

Organic listings in ranking order (id, url, title, seller, shopId, price with list price as original, image, rating and badges). The first products come from the page's structured data, where rating, badges and shopId are null or false; the rest are Etsy's own listing cards.

up to 48 items

items.idstring

Always included.

items.urlstring

Always included.

absolute HTTPS URL

items.titlestring

Always included.

items.sellerstringnullable

Always included.

items.shopIdstringnullable

Always included.

items.price.currentnumbernullable

Always included.

items.price.originalnumbernullable

Always included.

items.price.currencystring

Always included.

items.discountPercentintegernullable

Always included.

items.image_urlsstring[]

Always included.

items.rating.averagenumbernullable

Always included.

items.rating.countintegernullable

Always included.

items.freeShippingboolean

Always included.

items.isBestsellerboolean

Always included.

items.isAdboolean

Always included.

Promoted listing cards with shop name, rating, prices, discount and badges (isAd true).

up to 48 items

ads.idstring

Always included.

ads.urlstring

Always included.

absolute HTTPS URL

ads.titlestring

Always included.

ads.sellerstringnullable

Always included.

ads.shopIdstringnullable

Always included.

ads.price.currentnumbernullable

Always included.

ads.price.originalnumbernullable

Always included.

ads.price.currencystring

Always included.

ads.discountPercentintegernullable

Always included.

ads.image_urlsstring[]

Always included.

ads.rating.averagenumbernullable

Always included.

ads.rating.countintegernullable

Always included.

ads.freeShippingboolean

Always included.

ads.isBestsellerboolean

Always included.

ads.isAdboolean

Always included.

HTTP 200 returns the success variant. Check status: partial means usable data with warnings, and failed or challenged requests carry a failure object described in Errors & responses.

Error codes

HTTP	failure.code	Meaning
400	`invalid_request`	Missing, duplicate, ambiguous or unsupported parameters, unsupported URL forms, currencies or sorts.
401	`unauthorized`	Invalid API key.
404	`not_found`	Unknown shop, listing or reviews page.
429	`upstream_rate_limited`	Etsy rate limited the request.
502	`upstream_challenged`	Etsy's DataDome check did not clear (status challenged).
502	`unsafe_redirect`	Etsy redirected outside the requested resource (for example a removed listing's error page).
502	`unsupported_page`	Layout, identity or structured-data checks failed, or a non-HTML document was served.
502	`response_too_large`	The page exceeded 3 MiB.
502	`payload_too_complex`	The page exceeded parsing limits.
502	`request_limit`	The upstream document budget was exhausted.
502	`upstream_error`	Network failure or an unexpected upstream status after one retry.
503	`busy`	Both retrieval slots are occupied.
504	`timeout`	The 45-second deadline elapsed.

Code example

curl "https://api.scrapeatlas.com/v1/etsy/search?query=example+query" \
  -H "x-api-key: YOUR_API_KEY"

const response = await fetch(
  "https://api.scrapeatlas.com/v1/etsy/search?query=example+query",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY"
    }
  }
);

const data = await response.json();
console.log(data.status, data);

type Result = {
  status: "success" | "partial" | "failed" | "challenged";
  requestId: string;
  [field: string]: unknown;
};

const response = await fetch(
  "https://api.scrapeatlas.com/v1/etsy/search?query=example+query",
  {
    headers: {
      "x-api-key": process.env.SCRAPEATLAS_API_KEY!
    }
  }
);

const data = (await response.json()) as Result;
if (data.status === "failed" || data.status === "challenged") {
  throw new Error(`Etsy request failed: ${data.requestId}`);
}
console.log(data);

import requests

response = requests.get(
    "https://api.scrapeatlas.com/v1/etsy/search",
    headers={"x-api-key": "YOUR_API_KEY"},
    params={
        "query": "example query"
    },
    timeout=60,
)
data = response.json()
print(data["status"], data)

package main

import (
	"encoding/json"
	"fmt"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.scrapeatlas.com/v1/etsy/search?query=example+query", nil)
	req.Header.Set("x-api-key", "YOUR_API_KEY")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
	fmt.Println(data["status"], data)
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        var client = HttpClient.newHttpClient();
        var request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.scrapeatlas.com/v1/etsy/search?query=example+query"))
            .GET()
            .header("x-api-key", "YOUR_API_KEY")
            .build();
        var response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

Use your sa_live_… customer key at https://api.scrapeatlas.com.

Responses

Successful result. Synthetic example validated against the runtime contract.

{
  "success": true,
  "query": "example query",
  "sort": "most_relevant",
  "page": 1,
  "totalPages": 20,
  "nextPage": 2,
  "listingIds": [
    "900000000000001",
    "900000000000002",
    "900000000000003",
    "900000000000004"
  ],
  "items": [
    {
      "id": "900000000000001",
      "url": "https://www.etsy.com/listing/900000000000001/organic-result-one",
      "title": "Organic Result One",
      "seller": "ShopOne",
      "shopId": null,
      "price": {
        "current": 15.29,
        "original": 17.99,
        "currency": "USD"
      },
      "discountPercent": null,
      "image_urls": [
        "https://static.example.test/il_fullxfull.900.jpg"
      ],
      "rating": {
        "average": null,
        "count": null
      },
      "freeShipping": false,
      "isBestseller": false,
      "isAd": false
    },
    {
      "id": "900000000000002",
      "url": "https://www.etsy.com/listing/900000000000002/organic-result-two",
      "title": "Organic Result Two",
      "seller": "ShopTwo",
      "shopId": null,
      "price": {
        "current": 8,
        "original": null,
        "currency": "USD"
      },
      "discountPercent": null,
      "image_urls": [
        "https://static.example.test/il_fullxfull.901.jpg"
      ],
      "rating": {
        "average": null,
        "count": null
      },
      "freeShipping": false,
      "isBestseller": false,
      "isAd": false
    }
  ],
  "ads": [
    {
      "id": "900000000000011",
      "url": "https://www.etsy.com/listing/900000000000011/promoted-item",
      "title": "Promoted Item",
      "seller": "PromotedShop",
      "shopId": "310000001",
      "price": {
        "current": 2.24,
        "original": 2.99,
        "currency": "USD"
      },
      "discountPercent": 25,
      "image_urls": [
        "https://static.example.test/il_255x319.911.jpg"
      ],
      "rating": {
        "average": 4.9,
        "count": 9200
      },
      "freeShipping": true,
      "isBestseller": false,
      "isAd": true
    }
  ],
  "status": "partial",
  "requestId": "11111111-1111-4111-8111-111111111111",
  "sourceUrl": "https://www.etsy.com/search?q=example+query&explicit=1",
  "fetchedAt": "2026-09-11T12:00:00.000Z",
  "coverage": {
    "source": "public_page",
    "complete": false,
    "warnings": [
      "organic_results_partially_embedded"
    ]
  },
  "accounting": {
    "upstreamRequests": 1,
    "responseBytes": 123456,
    "durationMs": 4200
  }
}

Missing, duplicate, ambiguous or unsupported parameters, unsupported URL forms, currencies or sorts.

{
  "requestId": "9d2f1c0a-6b1e-4c7d-9a8e-2f3b4c5d6e7f",
  "accounting": {
    "upstreamRequests": 0,
    "responseBytes": 0,
    "durationMs": 0
  },
  "success": false,
  "status": "failed",
  "failure": {
    "code": "invalid_request",
    "message": "Invalid request: missing, duplicate, unsupported or malformed parameters."
  }
}