Get similar Etsy listings

Try in Playground

Read the listings Etsy recommends next to a public listing: up to 24 similar items and the promoted listings shown with them, as listing cards with canonical URL, title, shop ID, prices in the chosen currency, discount, image and badges.

GET/v1/etsy/listing/similarx-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

idstringquery

Optional.

Example100000000000001

urlstringquery

Optional.

max 2048 chars

currencyenumdefault: "USD"query

Optional.

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; the bare listing URL adds two canonical redirect hops), 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

Etsy's public recommendation module.

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.

Listing ID and canonical ID URL.

listing.idstring

Always included.

listing.urlstring

Always included.

absolute HTTPS URL

Similar listings in Etsy's order, de-duplicated; seller is null when the card names no shop.

up to 24 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 listings from the same module (isAd true).

up to 24 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/listing/similar?id=100000000000001" \
  -H "x-api-key: YOUR_API_KEY"

const response = await fetch(
  "https://api.scrapeatlas.com/v1/etsy/listing/similar?id=100000000000001",
  {
    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/listing/similar?id=100000000000001",
  {
    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/listing/similar",
    headers={"x-api-key": "YOUR_API_KEY"},
    params={
        "id": "100000000000001"
    },
    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/listing/similar?id=100000000000001", 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/listing/similar?id=100000000000001"))
            .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,
  "status": "success",
  "requestId": "11111111-1111-4111-8111-111111111111",
  "sourceUrl": "https://www.etsy.com/api/v3/ajax/bespoke/member/neu/specs/listing_async_bottom",
  "fetchedAt": "2026-09-11T12:00:00.000Z",
  "coverage": {
    "source": "public_api",
    "complete": true,
    "warnings": []
  },
  "accounting": {
    "upstreamRequests": 1,
    "responseBytes": 123456,
    "durationMs": 4200
  },
  "listing": {
    "id": "100000000000001",
    "url": "https://www.etsy.com/listing/100000000000001"
  },
  "items": [
    {
      "id": "900000000000021",
      "url": "https://www.etsy.com/listing/900000000000021/similar-example-item",
      "title": "Similar Example Item",
      "seller": null,
      "shopId": "310000009",
      "price": {
        "current": 24,
        "original": null,
        "currency": "USD"
      },
      "discountPercent": null,
      "image_urls": [
        "https://static.example.test/il_340x270.921.jpg"
      ],
      "rating": {
        "average": null,
        "count": null
      },
      "freeShipping": false,
      "isBestseller": false,
      "isAd": false
    }
  ],
  "ads": [
    {
      "id": "900000000000022",
      "url": "https://www.etsy.com/listing/900000000000022/promoted-similar-item",
      "title": "Promoted Similar Item",
      "seller": "PromotedShop",
      "shopId": "310000009",
      "price": {
        "current": 24,
        "original": null,
        "currency": "USD"
      },
      "discountPercent": null,
      "image_urls": [
        "https://static.example.test/il_340x270.921.jpg"
      ],
      "rating": {
        "average": 4.8,
        "count": 1200
      },
      "freeShipping": false,
      "isBestseller": false,
      "isAd": true
    }
  ]
}

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."
  }
}