{ "openapi": "3.0.1", "info": { "title": "Etsy Product Scraper", "description": "Scrape Etsy products by keyword or search URL. Fast overview (title, price, shop, rating, reviews, thumbnail) or full detail (full image gallery, tags, favorites, category, availability, description). Clean JSON/CSV, no code.", "version": "1.0", "x-build-id": "NBD86EzfdO4ApuGX1" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sian.agency~etsy-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sian.agency-etsy-product-scraper", "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/sian.agency~etsy-product-scraper/runs": { "post": { "operationId": "runs-sync-sian.agency-etsy-product-scraper", "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/sian.agency~etsy-product-scraper/run-sync": { "post": { "operationId": "run-sync-sian.agency-etsy-product-scraper", "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", "properties": { "scrapeMode": { "title": "⚙️ Scrape Mode", "enum": [ "overview", "detail" ], "type": "string", "description": "⚙️ **OVERVIEW vs DETAIL:**\n\n- **Overview** (fast & cheap): one row per search-result card — title, price, shop, rating, review count, thumbnail. Best for price monitoring and large catalogs.\n- **Detail** (full data): opens each product page — full image gallery, tags, favorites, breadcrumb category, availability and description. Best when you need the rich fields.", "default": "overview" }, "searchMode": { "title": "🔎 Search Mode", "enum": [ "byQuery", "bySearchUrl" ], "type": "string", "description": "🔎 **HOW TO REACH THE PRODUCTS:**\n\n- **By Query** — type a keyword and use the filter fields below.\n- **By Search URL** — paste one or more Etsy search URLs (filters and sort are carried over exactly).\n\n💡 In Detail mode you can instead provide specific listing URLs or IDs below.", "default": "byQuery" }, "query": { "title": "🔎 Search Query", "type": "string", "description": "🔎 **KEYWORD SEARCH:** The free-text term to search Etsy for, e.g. `leather wallet`, `ceramic mug`, `personalized gift`.\n\nUsed when **Search Mode = By keyword query**. Combine with the price, sort and shipping filters below.", "default": "leather wallet" }, "searchUrls": { "title": "🔗 Etsy Search URLs", "uniqueItems": true, "type": "array", "description": "🔗 **SEARCH URL PROCESSING:** Paste one or more Etsy search URLs (each must contain a `?q=` term). Filters and sort in the URL are carried through every page.\n\n💡 **TIP:** Set up your filters on etsy.com, then copy the address-bar URL.\n\n📋 Use **Bulk edit** to paste multiple URLs (one per line).", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "listingUrls": { "title": "📄 Listing URLs (Detail mode)", "uniqueItems": true, "type": "array", "description": "📄 **SPECIFIC PRODUCTS:** Paste exact Etsy listing URLs (e.g. `https://www.etsy.com/listing/1207159171/...`). Each is opened and fully parsed. Only used in **Detail** scrape mode.\n\n📋 Use **Bulk edit** to paste multiple URLs (one per line).", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "listingIds": { "title": "🔢 Listing IDs (Detail mode)", "uniqueItems": true, "type": "array", "description": "🔢 **SPECIFIC PRODUCT IDS:** Numeric Etsy listing IDs (e.g. `1207159171`). Each is opened and fully parsed. Only used in **Detail** scrape mode.", "items": { "type": "string" } }, "order": { "title": "↕️ Sort Order", "enum": [ "most_relevant", "price_asc", "price_desc", "date_desc", "highest_reviews" ], "type": "string", "description": "↕️ **SORT:** Etsy's own sort order for keyword searches.", "default": "most_relevant" }, "minPrice": { "title": "💲 Minimum Price (USD)", "minimum": 0, "type": "integer", "description": "💲 **MIN PRICE:** Only return products at or above this price (USD). Leave empty for no minimum." }, "maxPrice": { "title": "💲 Maximum Price (USD)", "minimum": 0, "type": "integer", "description": "💲 **MAX PRICE:** Only return products at or below this price (USD). Leave empty for no maximum." }, "freeShipping": { "title": "🚚 Free Shipping Only", "type": "boolean", "description": "🚚 **FREE SHIPPING:** Only return products that ship for free.", "default": false }, "maxResults": { "title": "🔢 Max Results", "minimum": 1, "type": "integer", "description": "🔢 **RESULT CAP:** Maximum number of products to return.\n\n**TIER-BASED LIMITS:**\n- **FREE users:** up to 25 products per run\n- **PAID users:** unlimited\n\nThe actor stops once this many products are collected.", "default": 100 } } }, "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 } } } } } } } } } }