{ "openapi": "3.0.1", "info": { "title": "Etsy Shop Details Scraper 🏪 Sales, Star-Seller & Emails", "description": "Paste Etsy shop URLs, get one clean row per shop: lifetime sales, rating + reviews, total listings, Star-Seller, slogan and logo — plus optional seller contact emails, payment-stack qualification, and the shop's products. Managed unblocker, zero config. JSON/CSV/Excel out.", "version": "0.0", "x-build-id": "C5c63PkJe5aNDz1Ia" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/memo23~etsy-shop-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-memo23-etsy-shop-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/memo23~etsy-shop-scraper/runs": { "post": { "operationId": "runs-sync-memo23-etsy-shop-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/memo23~etsy-shop-scraper/run-sync": { "post": { "operationId": "run-sync-memo23-etsy-shop-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": { "startUrls": { "title": "Etsy shop URLs", "type": "array", "description": "Etsy shop URLs — https://www.etsy.com/shop/{name}, one per shop. Each shop emits one dedicated shop row (name, lifetime sales, rating + review count, total listings, Star-Seller status, slogan, description, logo). Product / search / category URLs are also accepted and produce product rows.", "items": { "type": "string" } }, "searchQuery": { "title": "Search keyword (optional)", "type": "string", "description": "Optional: a keyword to search Etsy for, e.g. \"ceramic mug\" — its matching products are scraped as product rows (useful for discovering shops in a niche before profiling them)." }, "maxItems": { "title": "Maximum rows", "minimum": 1, "type": "integer", "description": "Hard cap on rows collected across all start URLs (shop rows + product rows). Set it to the number of shop URLs you pasted for a pure shop-details run.", "default": 10 }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "type": "integer", "description": "Pages fetched in parallel through the managed unblocker. Keep moderate (3–8); each page is one unblocker request.", "default": 5 }, "shopDetails": { "title": "Shop details row (one row per shop URL)", "type": "boolean", "description": "Emit one dedicated shop row (rowType: \"shop\") per shop URL — the core of this actor. Leave on.", "default": true }, "includeReviews": { "title": "Include sample reviews on product rows", "type": "boolean", "description": "When product rows are collected, include the recent customer reviews carried in each listing's structured data (author, rating, text, date).", "default": true }, "enrichSeller": { "title": "Also enrich product rows with shop/seller data", "type": "boolean", "description": "When product rows are collected, add the shop's lifetime sales, Star-Seller status, total listings, rating, and slogan/description onto each product row (one cached fetch per shop).", "default": false }, "enrichEmails": { "title": "Enrich with seller contact emails (billed per email)", "type": "boolean", "description": "Best-effort: discover each shop's own website (from its name + country) and harvest a contact email. Adds contactEmail, contactWebsite and a detailed emailEnrichment object. Billed per email found — never charged for misses.", "default": false }, "qualifyByPayment": { "title": "💳 Qualify by payment (flag businesses that take money online)", "type": "boolean", "description": "Requires \"Enrich with contact emails\". Scans each business's website — reusing the pages already fetched for email discovery, so no extra cost or time — for payment processors and e-commerce platforms (Stripe, Shopify, PayPal, Paddle, Lemon Squeezy, WooCommerce, Square, Chargebee and more). Adds takesPayments, paymentProcessors, stripeLiveKey and paymentConfidence. No extra charge — included with each enriched company.", "default": false }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "Proxy used for the direct enrichment fetches (e.g. seller email discovery). Etsy shop/product pages are fetched through a built-in managed unblocker, so this setting does not affect them. Paying users are routed through a premium residential pool automatically.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }