{ "openapi": "3.0.1", "info": { "title": "Etsy Best Sellers Scraper", "description": "Scrape best-selling product listings from Etsy search or category pages. Extracts title, price, rating, review count, shop name, and listing URL.", "version": "1.3", "x-build-id": "5GMzm7iHp6swBMLFs" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/w3crawler~etsy-best-sellers-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-w3crawler-etsy-best-sellers-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/w3crawler~etsy-best-sellers-scraper/runs": { "post": { "operationId": "runs-sync-w3crawler-etsy-best-sellers-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/w3crawler~etsy-best-sellers-scraper/run-sync": { "post": { "operationId": "run-sync-w3crawler-etsy-best-sellers-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 source URLs", "maxItems": 5, "type": "array", "description": "Optional public Etsy search, category, or best-sellers URLs. Up to five URLs; these take precedence over categoryUrl and searchQuery.", "items": { "type": "object", "additionalProperties": false, "properties": { "url": { "title": "Etsy URL", "type": "string", "description": "HTTPS public Etsy marketplace, category, search, or best-sellers URL." } }, "required": [ "url" ] }, "default": [] }, "searchQuery": { "title": "Search query", "maxLength": 200, "type": "string", "description": "Public Etsy search phrase. Leave empty to use best sellers." }, "categoryUrl": { "title": "Category URL", "type": "string", "description": "Optional HTTPS Etsy marketplace/category URL." }, "maxItems": { "title": "Maximum listings", "minimum": 1, "maximum": 200, "type": "integer", "description": "Maximum normal listing rows, from 1 to 200.", "default": 20 }, "maxPages": { "title": "Pages per source", "minimum": 1, "maximum": 5, "type": "integer", "description": "Maximum result pages to visit for each source URL.", "default": 1 }, "deduplicate": { "title": "Deduplicate listings", "type": "boolean", "description": "Deduplicate by Etsy listing ID across source pages.", "default": true }, "keyword": { "title": "Keyword filter", "maxLength": 200, "type": "string", "description": "Optional case-insensitive filter applied to listing title and shop name." }, "minPrice": { "title": "Minimum price", "type": "number", "description": "Optional lower bound for the parsed public price." }, "maxPrice": { "title": "Maximum price", "type": "number", "description": "Optional upper bound for the parsed public price." }, "minRating": { "title": "Minimum rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Optional minimum public rating from 0 to 5." }, "minReviewCount": { "title": "Minimum reviews", "minimum": 0, "type": "integer", "description": "Optional minimum public review count." }, "sortBy": { "title": "Sort results", "enum": [ "recommended", "price_asc", "price_desc", "rating_desc", "review_count_desc" ], "type": "string", "description": "Order applied after filtering and deduplication.", "default": "recommended" }, "includeDetails": { "title": "Open listing details", "type": "boolean", "description": "Open up to maxDetailItems public listing pages for additional fields.", "default": false }, "maxDetailItems": { "title": "Maximum detail pages", "minimum": 0, "maximum": 20, "type": "integer", "description": "Detail-page cap; effective only when includeDetails is enabled.", "default": 0 }, "includeReviews": { "title": "Include visible reviews", "type": "boolean", "description": "Keep a bounded sample of reviews found on opened public detail pages.", "default": false }, "maxReviews": { "title": "Maximum reviews", "minimum": 0, "maximum": 20, "type": "integer", "description": "Maximum visible reviews per detail page.", "default": 5 }, "requestDelayMs": { "title": "Delay between page checks", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Polite pause in milliseconds before extraction.", "default": 250 }, "maxConcurrency": { "title": "Maximum concurrency", "minimum": 1, "maximum": 2, "type": "integer", "description": "Bounded browser-page concurrency.", "default": 1 }, "maxRequestRetries": { "title": "Maximum request retries", "minimum": 0, "maximum": 2, "type": "integer", "description": "Bounded retry count for ordinary request failures.", "default": 1 }, "requestTimeoutSecs": { "title": "Request timeout", "minimum": 10, "maximum": 90, "type": "integer", "description": "Maximum navigation time in seconds.", "default": 45 } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }