{ "openapi": "3.0.1", "info": { "title": "Etsy Scraper - Listings, Shops, Prices and Reviews", "description": "Extract Etsy listings, shops, categories, and public review samples across ship-to markets. Get prices, ratings, images, and shop details. Pay per delivered row plus a start fee.", "version": "0.1", "x-build-id": "ff0cG2lzjuz7iDD4e" }, "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": [ "auto", "search", "search_shops", "category", "listing", "shop", "categories", "featured", "reference" ], "type": "string", "description": "Auto picks the mode from the fields you fill: a URL, listing ID, shop, category, featured path or keyword. Choose a mode only to force it, or to fetch a reference dataset.", "default": "auto" }, "query": { "title": "Search query", "type": "string", "description": "Keyword to search for, e.g. ceramic planter. Used by the search modes." }, "searchQueries": { "title": "Search queries", "type": "array", "description": "Optional list of search inputs. Each query gets its own maxResults row allowance; leave query empty to use the list.", "items": { "type": "string" } }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Etsy links: search (/search?q=...), category (/c/...), listing (/listing/), shop (/shop/), featured (/featured/... or /r/curated/...). The page type sets the mode.", "items": { "type": "string" } }, "listingId": { "title": "Listing ID", "pattern": "^\\s*\\d*\\s*$", "type": "string", "description": "Number from the listing link (etsy.com/listing/)." }, "shopName": { "title": "Shop name", "type": "string", "description": "Shop name from the link etsy.com/shop/." }, "shopId": { "title": "Shop ID", "pattern": "^\\s*\\d*\\s*$", "type": "string", "description": "Numeric shop ID for shop information and first-page listings. Use US/USD English settings." }, "dataset": { "title": "Reference dataset", "enum": [ "countries", "currencies", "languages" ], "type": "string", "description": "Reference dataset for the reference mode." }, "categorySlug": { "title": "Category slug", "type": "string", "description": "Category path after /c/, e.g. jewelry or jewelry/necklaces." }, "featuredPath": { "title": "Featured path", "type": "string", "description": "Path of a featured page, e.g. /featured/hub or /r/curated/..." }, "maxResults": { "title": "Max results per input", "minimum": 1, "maximum": 500, "type": "integer", "description": "Most rows for each query, URL, listing, shop, category, or featured path. Default 70; larger numbers are collected in parts of 70. Listings, shops, and reviews count together. The whole run stops at your maximum total charge. Free Apify plan: up to 200 rows per run and 10 runs of this Actor (limits set by the Actor developer).", "default": 70 }, "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": "Destination market code for currency and language preferences. ROW uses USD as a fallback.", "default": "US" }, "includeShopReviews": { "title": "Include shop review sample", "type": "boolean", "description": "Include first-page public reviews for numeric shop inputs as separate billed rows, without buyer identity fields. Off by default; reviews share the row limit with the shop and its listings.", "default": false }, "enrichDetails": { "title": "Enrich listing details", "type": "boolean", "description": "Add available listing descriptions, shipping information, images, and variations. On by default; extra details are not guaranteed for every row.", "default": true }, "order": { "title": "Sort order", "enum": [ "most_relevant", "price_asc", "price_desc", "date_desc" ], "type": "string", "description": "Sort listings by relevance, lowest price, highest price, or newest first.", "default": "most_relevant" }, "p": { "title": "Start page", "minimum": 1, "maximum": 500, "type": "integer", "description": "Starting search page, from 1 to 500. Available pages depend on the search; some searches stop at page 99.", "default": 1 }, "priceMin": { "title": "Min price", "type": "number", "description": "Minimum listing price in the selected currency. Leave empty for no minimum." }, "priceMax": { "title": "Max price", "type": "number", "description": "Maximum listing price in the selected currency. Leave empty for no maximum." }, "instantDownload": { "title": "Digital downloads", "type": "boolean", "description": "Filter listings by digital-download availability. Leave unset to include all listings." }, "shipsFrom": { "title": "Ships from", "type": "string", "description": "Seller location to use as a search filter. Leave empty for any origin." }, "readyToShip": { "title": "Ready to ship", "type": "boolean", "description": "Request listings with a short delivery window. Availability depends on the destination and Etsy results." }, "starSeller": { "title": "Star Seller only", "type": "boolean", "description": "Request listings from Star Sellers. Leave unset for no Star Seller filter." }, "freeShipping": { "title": "Free shipping", "type": "boolean", "description": "Request listings with free shipping. Availability depends on the selected market." }, "language": { "title": "Language", "type": "string", "description": "Optional language preference, such as en. Leave empty to use the market preference; this does not translate search words." }, "currency": { "title": "Currency", "type": "string", "description": "Optional price currency preference, such as USD or GBP. Leave empty to use the market preference." }, "provider": { "title": "Collection option", "enum": [ "auto", "etsy-app", "camoufox", "geonode-extract", "camoufox-base" ], "type": "string", "description": "Leave at auto for normal runs. Other choices are intended for advanced compatibility checks.", "default": "auto" }, "workerBaseUrl": { "title": "Developer test setting", "type": "string", "description": "Leave empty. Used only by the developer for testing." } } }, "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 } } } } } } } } } }