Get Etsy search suggestions

Try in Playground

Retrieve Etsy search autocomplete terms for a partial query.

GET/v1/etsy/search/suggestionsx-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

Partial search text (1-200 characters).

min 1 chars · max 200 chars

Exampleexample

Response fields

requestIdstring

Request correlation UUID.

Upstream document reads (a DataDome device check adds one read), 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

Partial search text (1-200 characters).

Suggested queries in source order; each item carries only query.

up to 20 items

items.querystring

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/suggestions?query=example" \
  -H "x-api-key: YOUR_API_KEY"

const response = await fetch(
  "https://api.scrapeatlas.com/v1/etsy/search/suggestions?query=example",
  {
    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/suggestions?query=example",
  {
    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/suggestions",
    headers={"x-api-key": "YOUR_API_KEY"},
    params={
        "query": "example"
    },
    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/suggestions?query=example", 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/suggestions?query=example"))
            .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",
  "items": [
    {
      "query": "example bag"
    },
    {
      "query": "example jacket"
    },
    {
      "query": "example wallet"
    }
  ],
  "status": "success",
  "requestId": "11111111-1111-4111-8111-111111111111",
  "sourceUrl": "https://www.etsy.com/api/v3/ajax/public/search/autosuggest?search_type=all&query=example",
  "fetchedAt": "2026-09-11T12:00:00.000Z",
  "coverage": {
    "source": "public_api",
    "complete": true,
    "warnings": []
  },
  "accounting": {
    "upstreamRequests": 1,
    "responseBytes": 303,
    "durationMs": 180
  }
}

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