{ "openapi": "3.0.1", "info": { "title": "Etsy Scraper Pro - Sale Prices & Discount Depth", "description": "Scrape Etsy search, category and market pages and get the struck-through original price on every discounted listing, so you can compute real markdown depth per item. Ratings, review counts and prices come back null when Etsy did not publish them, never a fake 0. Up to 250 per run, no proxy setup.", "version": "1.0", "x-build-id": "VFhhbE3okjZfJLRUP" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/webdatalabs~etsy-scraper-pro/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-webdatalabs-etsy-scraper-pro", "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/webdatalabs~etsy-scraper-pro/runs": { "post": { "operationId": "runs-sync-webdatalabs-etsy-scraper-pro", "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/webdatalabs~etsy-scraper-pro/run-sync": { "post": { "operationId": "run-sync-webdatalabs-etsy-scraper-pro", "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": { "query": { "title": "Search Query", "type": "string", "description": "What to search for on Etsy (e.g. 'handmade jewelry', 'vintage watch', 'ceramic mug')." }, "searchUrl": { "title": "Etsy Search URL (alternative to query)", "pattern": "^https?://(?:[a-z0-9-]+\\.)?etsy\\.com/", "type": "string", "description": "Paste an Etsy search-results, category or market URL instead of a query. Supported: https://www.etsy.com/search?q=vintage%20watch, https://www.etsy.com/c/jewelry, https://www.etsy.com/market/vintage_watch. NOT supported: single product pages (/listing/12345/...) or shop storefronts (/shop/ShopName) - this actor scrapes search results, not product or shop pages. If you also fill in Search Query, the query wins." }, "maxItems": { "title": "Maximum Results", "minimum": 1, "maximum": 250, "type": "integer", "description": "How many products to return. One search page holds ~48-64 listings; higher values page through additional results.", "default": 48 }, "minRating": { "title": "Minimum Rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Only keep products with at least this star rating. Decimals are allowed (4.5 is a useful cut-off, since almost every rated Etsy listing sits between 4 and 5). Listings that do not publish a rating on the card are withheld, because the actor cannot verify they match. Leave empty for no filter." }, "minReviews": { "title": "Minimum Reviews", "minimum": 0, "type": "integer", "description": "Only keep products with at least this many reviews. Listings that do not publish a review count on the card are withheld, because the actor cannot verify they match. Leave empty for no filter." }, "priceMin": { "title": "Minimum Price (USD)", "minimum": 0, "type": "integer", "description": "Only keep products priced at or above this. Leave empty for no filter." }, "priceMax": { "title": "Maximum Price (USD)", "minimum": 0, "type": "integer", "description": "Only keep products priced at or below this. Leave empty for no filter." }, "debug": { "title": "Debug Mode", "type": "boolean", "description": "Save a screenshot + HTML of every page to the key-value store for troubleshooting. Blocked pages are always saved.", "default": false } } }, "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 } } } } } } } } } }