# Etsy Open API v3 - Handmade Products Multi-Country (`viralanalyzer/etsy-product-intelligence`) Actor Query Etsy Open API v3 for active handmade and vintage listings across US/UK/DE/FR/CA/AU/ES/IT. BYOC (bring your own free API keystring from etsy.com/developers). ToS-compliant, anti-bot-immune, 98% margin. - **URL**: https://apify.com/viralanalyzer/etsy-product-intelligence.md - **Developed by:** [viralanalyzer](https://apify.com/viralanalyzer) (community) - **Categories:** E-commerce, Lead generation - **Stats:** 1 total users, 0 monthly users, 0.0% runs succeeded, NaN bookmarks - **User rating**: No ratings yet ## Pricing from $2.00 / 1,000 product scrapeds This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. Since this Actor supports Apify Store discounts, the price gets lower the higher subscription plan you have. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## 🛍️ Etsy Open API v3 — Handmade & Vintage Products (BYOC) > 🔗 [View on Apify Store](https://apify.com/viralanalyzer/etsy-product-intelligence) | 🇺🇸 English | [🇧🇷 Português](#português) Query **Etsy Open API v3** for active handmade and vintage product listings across 8+ countries. **BYOC (Bring Your Own Credentials)** model — you provide your free personal Etsy API keystring, we handle the rest. Anti-bot-immune (official API), ~98% margin, predictable cost. ### ✨ Features - **Official Etsy Open API v3** — no HTML scraping, no anti-bot blocks - **8 country filters** — US, UK, DE, FR, CA, AU, ES, IT + `ANY` - **Keyword search** with sort by relevance/price/date - **Price range filter** (`minPrice` / `maxPrice`) - **Auto-pagination** up to 500 results (100 per page hard cap by Etsy) - **Rich output** — `tags`, `materials`, `who_made`, `when_made`, `num_favorers`, `views`, `taxonomy_id`, `style`, shop info - **Rate-limit aware** — built-in 250ms pause (under 5 QPS personal limit) - **NEVER 0 ITEMS guard** — actor fails loudly with diagnosis instead of silently succeeding ### 🔑 BYOC setup (one-time, free, ~5 min) 1. Sign in at https://www.etsy.com/developers 2. Click **Create a New App** (or use an existing one) 3. After approval (1-7 days for personal review), copy your **Keystring** from "Your Apps" 4. Paste the Keystring in the actor input under **Etsy API Keystring (BYOC)** > **Important**: New keys arrive with status **"Pending Personal Approval"**. The actor will throw `[ETSY_AUTH] 403 API key not found or not active` until Etsy reviewers activate it. This is normal — wait for the email. **Limits**: Free tier = **5 QPS / 5K queries per day**. Plenty for most affiliate research workflows. ### 📥 Input | Parameter | Type | Required | Default | Description | |---|---|---|---|---| | `keystring` | string (secret) | **Yes** | — | Your Etsy API keystring (see BYOC setup above) | | `searchQuery` | string | **Yes** | — | Search term (e.g. "handmade jewelry") | | `country` | enum | No | `US` | Origin country filter (US/UK/DE/FR/CA/AU/ES/IT/ANY) | | `sortOn` | enum | No | `score` | Sort dimension: `score`/`price`/`created`/`updated` | | `sortOrder` | enum | No | `desc` | `asc` or `desc` | | `minPrice` | integer | No | 0 | Minimum price (in country currency, 0 = no filter) | | `maxPrice` | integer | No | 0 | Maximum price (0 = no filter) | | `maxResults` | integer | No | 24 | Total listings to fetch (1-500) | #### Input example ```json { "keystring": "your_etsy_keystring_here", "searchQuery": "wedding ring rose gold", "country": "US", "minPrice": 100, "maxPrice": 1000, "maxResults": 50 } ```` ### 📤 Output Each record contains: ```json { "listingId": 1234567890, "title": "Handmade Rose Gold Wedding Ring — Custom Engraving", "description": "Beautiful handmade ring crafted in our small studio…", "url": "https://www.etsy.com/listing/1234567890/...", "price": 245.0, "currency": "USD", "state": "active", "whoMade": "i_did", "whenMade": "made_to_order", "isSupply": false, "isCustomizable": true, "isDigital": false, "quantity": 999, "views": 4521, "numFavorers": 138, "tags": ["wedding ring", "rose gold", "engagement"], "materials": ["14k rose gold", "diamond"], "styleTags": ["minimalist"], "taxonomyId": 1234, "originCountryIso": "US", "shop": { "shopId": 5555, "shopName": "BohoJewelryStudio", "url": "https://www.etsy.com/shop/BohoJewelryStudio" }, "thumbnail": "https://i.etsystatic.com/.../il_570xN.jpg", "createdAt": 1715000000, "updatedAt": 1715800000, "countryFilter": "US", "source": "etsy-open-api-v3" } ``` ### 💰 Pricing Pay-per-event (PPE): only charged when the actor returns a real listing. Zero results → zero charge. Anti-bot blocks are impossible here (official API). ### 🚀 Use cases - **Affiliate research** — surface high-favorers handmade niches before saturation - **Price intelligence** — track competitor pricing in handmade/vintage verticals - **Trend discovery** — sort by `created` desc + `score` to spot rising listings - **Catalog import** — seed your own e-commerce or comparison site - **SEO content** — extract `tags` + `materials` for long-tail keyword research ### ⚠️ Common errors | Error | Cause | Fix | |---|---|---| | `[ETSY_AUTH] 401 Unauthorized` | Keystring invalid or expired | Verify at https://www.etsy.com/developers/your-apps | | `[ETSY_AUTH] 403 API key not found or not active` | Key still **Pending Personal Approval** | Wait 1-7 days for Etsy review | | `[ETSY_RATE] 429 Too Many Requests` | Hit 5 QPS / 5K QPD personal limit | Wait or upgrade Etsy app tier | | `[FAIL] Zero listings returned` | Filter too restrictive | Try `country: "ANY"` or broader keyword | ### 🔒 Privacy Your keystring is passed **directly** to `api.etsy.com` over HTTPS. We never store, log, or proxy it through our servers. Mark the input field as secret in Apify Console. ### 📚 Related actors - [Rakuten Affiliate Merchants](https://apify.com/viralanalyzer/rakuten-affiliate-merchants) — Rakuten API (BYOC) - [CJ Affiliate Products](https://apify.com/viralanalyzer/cj-affiliate-products) — Commission Junction GraphQL (BYOC) - [Impact.com Affiliate API](https://apify.com/viralanalyzer/impact-affiliate-network) — Impact.com REST (BYOC) - [Awin Multi-Merchant](https://apify.com/viralanalyzer/awin-multi-merchant-affiliate) — Awin Publisher API (BYOC) ### 🆕 Changelog - **v2.0** (2026-05-14): **Major refactor** from Playwright HTML scraping (HTTP 403 anti-bot blocked all attempts) to Etsy Open API v3 (BYOC). 98% margin, anti-bot-immune, ToS-compliant. Output adds `tags`, `materials`, `whoMade`, `views`, `numFavorers`, `taxonomyId`. - **v1.1** (2026-05-14): Playwright + RESIDENTIAL fingerprints attempted; Etsy Akamai still 403 → deprecated. - **v1.0** (2026-05-12): Initial CheerioCrawler release. *** ### Português ## 🛍️ Etsy Open API v3 — Produtos Artesanais e Vintage (BYOC) Consulta a **API oficial Etsy Open API v3** para listings de produtos artesanais e vintage ativos em 8+ países. **BYOC (Bring Your Own Credentials)** — você fornece sua keystring pessoal grátis do Etsy, nós cuidamos do resto. Imune a anti-bot (API oficial), margem ~98%, custo previsível. #### Setup BYOC (uma vez, grátis, ~5 min) 1. Entre em https://www.etsy.com/developers 2. Crie um app (ou use um existente) 3. Após aprovação (1-7 dias para revisão pessoal), copie sua **Keystring** em "Your Apps" 4. Cole no campo **Etsy API Keystring (BYOC)** do input do actor **Importante**: novas chaves chegam com status **"Pending Personal Approval"**. O actor retorna `[ETSY_AUTH] 403 API key not found or not active` até o Etsy ativar. Aguarde o email. **Limites**: tier grátis = **5 req/seg / 5K req/dia**. Suficiente para a maioria dos casos de uso. # Actor input Schema ## `keystring` (type: `string`): Your personal Etsy API keystring from https://www.etsy.com/developers/your-apps. Free signup. We NEVER store this — passed straight to api.etsy.com. ## `sharedSecret` (type: `string`): Your Etsy app Shared Secret. Found right next to Keystring at https://www.etsy.com/developers/your-apps. Etsy Open API v3 requires both concatenated as 'keystring:sharedSecret' for authentication. ## `searchQuery` (type: `string`): Etsy search term (e.g. 'handmade jewelry', 'vintage poster', 'wedding ring') ## `country` (type: `string`): Filter to listings shipping from a specific country. Affects currency in output too. ## `sortOn` (type: `string`): Etsy API sort dimension. ## `sortOrder` (type: `string`): Sort direction (ascending or descending). ## `minPrice` (type: `integer`): Minimum price in chosen currency (0 = no filter). ## `maxPrice` (type: `integer`): Maximum price in chosen currency (0 = no filter). ## `maxResults` (type: `integer`): Maximum products to fetch across pages (Etsy returns up to 100 per page; we paginate). ## Actor input object example ```json { "searchQuery": "handmade jewelry", "country": "US", "sortOn": "score", "sortOrder": "desc", "minPrice": 0, "maxPrice": 0, "maxResults": 12 } ``` # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "searchQuery": "handmade jewelry", "country": "US", "maxResults": 12 }; // Run the Actor and wait for it to finish const run = await client.actor("viralanalyzer/etsy-product-intelligence").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "searchQuery": "handmade jewelry", "country": "US", "maxResults": 12, } # Run the Actor and wait for it to finish run = client.actor("viralanalyzer/etsy-product-intelligence").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "searchQuery": "handmade jewelry", "country": "US", "maxResults": 12 }' | apify call viralanalyzer/etsy-product-intelligence --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=viralanalyzer/etsy-product-intelligence", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Etsy Open API v3 - Handmade Products Multi-Country", "description": "Query Etsy Open API v3 for active handmade and vintage listings across US/UK/DE/FR/CA/AU/ES/IT. BYOC (bring your own free API keystring from etsy.com/developers). ToS-compliant, anti-bot-immune, 98% margin.", "version": "2.1", "x-build-id": "xQ78DcqZ8LLY0lavk" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/viralanalyzer~etsy-product-intelligence/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-viralanalyzer-etsy-product-intelligence", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/viralanalyzer~etsy-product-intelligence/runs": { "post": { "operationId": "runs-sync-viralanalyzer-etsy-product-intelligence", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/viralanalyzer~etsy-product-intelligence/run-sync": { "post": { "operationId": "run-sync-viralanalyzer-etsy-product-intelligence", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "keystring", "sharedSecret", "searchQuery" ], "properties": { "keystring": { "title": "Etsy API Keystring (BYOC)", "type": "string", "description": "Your personal Etsy API keystring from https://www.etsy.com/developers/your-apps. Free signup. We NEVER store this — passed straight to api.etsy.com." }, "sharedSecret": { "title": "Etsy API Shared Secret (BYOC)", "type": "string", "description": "Your Etsy app Shared Secret. Found right next to Keystring at https://www.etsy.com/developers/your-apps. Etsy Open API v3 requires both concatenated as 'keystring:sharedSecret' for authentication." }, "searchQuery": { "title": "Search Query", "type": "string", "description": "Etsy search term (e.g. 'handmade jewelry', 'vintage poster', 'wedding ring')" }, "country": { "title": "Country / Currency filter", "enum": [ "US", "UK", "DE", "FR", "CA", "AU", "ES", "IT", "ANY" ], "type": "string", "description": "Filter to listings shipping from a specific country. Affects currency in output too.", "default": "US" }, "sortOn": { "title": "Sort by", "enum": [ "score", "price", "created", "updated" ], "type": "string", "description": "Etsy API sort dimension.", "default": "score" }, "sortOrder": { "title": "Sort order", "enum": [ "asc", "desc" ], "type": "string", "description": "Sort direction (ascending or descending).", "default": "desc" }, "minPrice": { "title": "Min price", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Minimum price in chosen currency (0 = no filter).", "default": 0 }, "maxPrice": { "title": "Max price", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Maximum price in chosen currency (0 = no filter).", "default": 0 }, "maxResults": { "title": "Max Results", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum products to fetch across pages (Etsy returns up to 100 per page; we paginate).", "default": 24 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } } ```