{ "openapi": "3.0.1", "info": { "title": "Etsy Product Scraper — Listings, Shops & Prices", "description": "Extract public Etsy product listings, shops, prices, reviews, shipping signals, images, and listing metadata for marketplace research.", "version": "1.0", "x-build-id": "BIyjaqZwoRddS5IvW" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/junipr~etsy-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-junipr-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/junipr~etsy-product-scraper/runs": { "post": { "operationId": "runs-sync-junipr-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/junipr~etsy-product-scraper/run-sync": { "post": { "operationId": "run-sync-junipr-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": { "searchQuery": { "title": "Search Query", "type": "string", "description": "Search term to find products on Etsy (e.g. \"handmade jewelry\", \"vintage poster\", \"custom mug\").", "default": "handmade jewelry" }, "shopUrl": { "title": "Shop URL", "type": "string", "description": "Direct Etsy shop URL to scrape all listings from (e.g. \"https://www.etsy.com/shop/ArtisanJewels\"). Leave empty to use search query instead.", "default": "" }, "urls": { "title": "Direct Listing URLs", "type": "array", "description": "Array of direct Etsy listing URLs to scrape. Each URL should be a full Etsy listing URL.", "items": { "type": "string" }, "default": [] }, "maxResults": { "title": "Max Results", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of product listings to extract.", "default": 3 }, "maxPages": { "title": "Max Pages", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum number of search result or shop pages to crawl.", "default": 3 }, "sortBy": { "title": "Sort By", "enum": [ "relevance", "date_desc", "price_asc", "price_desc", "most_favored" ], "type": "string", "description": "Sort order for search results.", "default": "relevance" }, "minPrice": { "title": "Minimum Price", "minimum": 0, "type": "integer", "description": "Filter results by minimum price in USD. Leave empty for no minimum.", "default": 0 }, "maxPrice": { "title": "Maximum Price", "minimum": 0, "type": "integer", "description": "Filter results by maximum price in USD. Leave 0 for no maximum.", "default": 0 }, "freeShipping": { "title": "Free Shipping Only", "type": "boolean", "description": "Only return products that offer free shipping.", "default": false }, "requestDelay": { "title": "Request Delay (ms)", "minimum": 1000, "maximum": 30000, "type": "integer", "description": "Minimum delay between requests in milliseconds. Etsy blocks fast crawlers — keep at 2000ms or higher.", "default": 2000 }, "maxConcurrency": { "title": "Max Concurrency", "minimum": 1, "maximum": 3, "type": "integer", "description": "Maximum number of pages to crawl simultaneously. Lower values reduce blocking risk.", "default": 1 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Residential proxy is recommended — Etsy blocks datacenter IPs. Defaults to Apify residential proxy (requires paid Apify plan). Free-plan users can provide their own residential proxy URL.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } }, "maxChargeUsd": { "title": "Max Charge USD", "minimum": 0, "type": "number", "description": "Stop before paid output would exceed the configured max charge.", "default": 50 }, "debugMode": { "title": "Debug Mode", "type": "boolean", "description": "Write extra free diagnostics to the key-value store.", "default": false }, "saveRawHtmlToKvs": { "title": "Save Raw HTML to KVS", "type": "boolean", "description": "Save raw snapshots as free debug artifacts when enabled.", "default": false }, "requestTimeout": { "title": "Request Timeout (ms)", "minimum": 1000, "maximum": 120000, "type": "integer", "description": "Maximum time to wait for a request or page load.", "default": 30000 }, "maxRetries": { "title": "Max Retries", "minimum": 0, "maximum": 3, "type": "integer", "description": "Maximum retry attempts per source.", "default": 1 }, "searchTerms": { "title": "Search Terms", "type": "string", "description": "Run setting used to control cost, runtime, and output size." }, "sourceMode": { "title": "Source Mode", "enum": [ "livePublic", "suppliedSnapshot", "provider" ], "type": "string", "description": "Use public live targets, supplied snapshots, or provider-backed source data when supported.", "default": "livePublic" }, "suppliedSnapshotHtml": { "title": "Supplied Snapshot HTML", "type": "string", "description": "Optional HTML snapshot for deterministic public-data extraction tests or controlled source capture." }, "suppliedSnapshotJson": { "title": "Supplied Snapshot JSON", "type": "string", "description": "Optional JSON snapshot/provider response for deterministic public-data extraction tests or controlled source capture." }, "suppliedSnapshotText": { "title": "Supplied Snapshot Text", "type": "string", "description": "Optional plain text snapshot for text-analysis actors." } } }, "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 } } } } } } } } } }