{ "openapi": "3.0.1", "info": { "title": "Etsy Scraper | Listings Shops Categories Prices", "description": "Scrape Etsy.com listings, shops & categories — keyword search, nested PLPs, PDP enrich, multi-market ship-to. Extract listingId, prices, ratings, images, badges. Export Excel/CSV/JSON.", "version": "0.1", "x-build-id": "Yld59m6YE0KXn5Pwf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lentic_clockss~etsy-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lentic_clockss-etsy-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/lentic_clockss~etsy-scraper/runs": { "post": { "operationId": "runs-sync-lentic_clockss-etsy-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/lentic_clockss~etsy-scraper/run-sync": { "post": { "operationId": "run-sync-lentic_clockss-etsy-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": { "mode": { "title": "Mode", "enum": [ "search", "search_shops", "category", "listing", "shop", "categories", "featured" ], "type": "string", "description": "search | search_shops | category | listing | shop | categories | featured", "default": "search" }, "shipTo": { "title": "Ship to market", "enum": [ "US", "GB", "CA", "AU", "DE", "FR", "IT", "ES", "NL", "IE", "NZ", "JP", "IN", "PH", "MX", "BR", "SE", "DK", "NO", "CH", "AT", "BE", "PL", "KR", "SG", "TW", "HK", "AE", "SA", "TR", "ROW" ], "type": "string", "description": "ISO-2 ship-to / regional prefs (currency & language). ROW = fallback USD.", "default": "US" }, "query": { "title": "Search query", "type": "string", "description": "Keyword for mode=search or search_shops", "default": "ceramic planter" }, "searchQueries": { "title": "Search queries", "type": "array", "description": "Optional list; first used if query empty", "items": { "type": "string" } }, "categorySlug": { "title": "Category slug", "type": "string", "description": "Top-level or nested path under /c/ e.g. jewelry or jewelry/necklaces" }, "listingId": { "title": "Listing ID", "type": "string", "description": "Numeric listing id for mode=listing" }, "shopName": { "title": "Shop name", "type": "string", "description": "/shop/{name} for mode=shop" }, "featuredPath": { "title": "Featured path", "type": "string", "description": "Path for mode=featured e.g. /featured/hub or /r/curated/..." }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Optional Etsy URLs (search, /c/, /listing/, /shop/, /featured/, /r/curated/)", "items": { "type": "string" } }, "order": { "title": "Sort order", "enum": [ "most_relevant", "price_asc", "price_desc", "date_desc" ], "type": "string", "description": "Verified URL codes only: most_relevant (omit) | price_asc | price_desc | date_desc", "default": "most_relevant" }, "p": { "title": "Start page", "minimum": 1, "maximum": 500, "type": "integer", "description": "SERP page number (page=N)", "default": 1 }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum rows to return (free plan capped at 200)", "default": 1 }, "enrichDetails": { "title": "Enrich listing details", "type": "boolean", "description": "Open PDPs for JSON-LD + shipping/sales/images enrichment. Default on for lead fields.", "default": true }, "priceMin": { "title": "Min price", "type": "number", "description": "Optional min filter (URL min=)" }, "priceMax": { "title": "Max price", "type": "number", "description": "Optional max filter (URL max=)" }, "instantDownload": { "title": "Digital downloads", "type": "boolean", "description": "true/false → instant_download=; omit for all" }, "shipsFrom": { "title": "Ships from", "type": "string", "description": "Ships-from / location facet (locationQuery)" }, "readyToShip": { "title": "Ready to ship", "type": "boolean", "description": "Short EDD window filter (edd=1)" }, "starSeller": { "title": "Star Seller only", "type": "boolean", "description": "is_star_seller=true" }, "freeShipping": { "title": "Free shipping", "type": "boolean", "description": "free_shipping=true" }, "language": { "title": "Language", "type": "string", "description": "Optional language preference override" }, "currency": { "title": "Currency", "type": "string", "description": "Optional currency preference override (USD, GBP, …)" }, "workerBaseUrl": { "title": "Worker base URL override", "type": "string", "description": "Optional HTTPS allowlisted Cloud Run URL override" } } }, "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 } } } } } } } } } }