{ "openapi": "3.0.1", "info": { "title": "Etsy Scraper — Product Research, Shops & Listings", "description": "Etsy scraper for product research: scrape Etsy search results, categories, shops and listings to JSON/CSV. Titles, prices, shops, badges, ad flags, plus optional favorites, variations, category and description. No login. $1.20/1k.", "version": "1.5", "x-build-id": "WLfFHdHv5hbyx1WeZ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/umararshad2~etsy-search-listings-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-umararshad2-etsy-search-listings-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/umararshad2~etsy-search-listings-scraper/runs": { "post": { "operationId": "runs-sync-umararshad2-etsy-search-listings-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/umararshad2~etsy-search-listings-scraper/run-sync": { "post": { "operationId": "run-sync-umararshad2-etsy-search-listings-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": { "searchQueries": { "title": "Search keywords", "type": "array", "description": "One or more Etsy search keywords, e.g. `handmade candles`, `personalized necklace`, `wedding invitations`. Each keyword is paged independently. Provide keywords and/or Start URLs.", "items": { "type": "string" } }, "startUrls": { "title": "Etsy URLs (search, category, shop or listing)", "type": "array", "description": "Paste public Etsy URLs: search (`https://www.etsy.com/search?q=mug`), category (`/c/...`), market (`/market/...`), shop (`https://www.etsy.com/shop/ShopName`) or a single listing (`https://www.etsy.com/listing/123456789`). Listing URLs always return full details. Login, cart and /api/ URLs are ignored.", "items": { "type": "string" } }, "maxItems": { "title": "Max listings", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of listings in the dataset (deduplicated by listing ID). Default and form prefill are 20 for a cheap first run (about a minute). Raise it for bigger jobs. You only pay for listings delivered.", "default": 20 }, "maxPages": { "title": "Max pages per keyword / URL", "minimum": 1, "maximum": 40, "type": "integer", "description": "Max result pages per keyword, search URL or shop. Etsy server-renders ~12 listings per search page (the rest load via JavaScript); with “Include full listing details” on, the Actor also collects those lazy-loaded listings (~48 per page). Default 10.", "default": 10 }, "includeDetails": { "title": "Include full listing details", "type": "boolean", "description": "Open each listing page and add description, tags, materials, category, all images, favorites, listing rating & review count, variations, ships-from and availability. Slower, and charged as an extra `listing-detail-scraped` event per listing. If a listing page can't be loaded, you still get (and only pay for) the search-card data.", "default": false }, "sort": { "title": "Sort by", "enum": [ "relevancy", "newest", "price_asc", "price_desc" ], "type": "string", "description": "Etsy search sort order (applies to keywords and search URLs without their own order).", "default": "relevancy" }, "minPrice": { "title": "Min price", "minimum": 0, "type": "integer", "description": "Only listings priced at or above this amount (in the ship-to country's currency, e.g. USD for US)." }, "maxPrice": { "title": "Max price", "minimum": 0, "type": "integer", "description": "Only listings priced at or below this amount." }, "freeShipping": { "title": "Free shipping only", "type": "boolean", "description": "Only listings with free shipping to the ship-to country.", "default": false }, "onSale": { "title": "On sale only", "type": "boolean", "description": "Only discounted listings.", "default": false }, "digitalOnly": { "title": "Digital downloads only", "type": "boolean", "description": "Only instant-download (digital) listings — printables, SVGs, patterns, templates.", "default": false }, "starSellerOnly": { "title": "Star Sellers only", "type": "boolean", "description": "Only listings from Etsy Star Sellers.", "default": false }, "shipTo": { "title": "Ship-to country", "type": "string", "description": "Two-letter country code (US, GB, CA, AU, DE, FR, …). Etsy shows listings and prices for buyers in this country." }, "country": { "title": "Country (alias of ship-to)", "type": "string", "description": "Alias for Ship-to country; used only when Ship-to is empty." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Etsy blocks datacenter IPs. Keep the default UNBLOCKER group (recommended). Blocked pages are retried automatically with fresh sessions and alternate exit countries.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "UNBLOCKER" ] } }, "useMockData": { "title": "Use fixture data (testing)", "type": "boolean", "description": "Developer option: parse bundled fixture HTML instead of calling Etsy.", "default": false }, "debugSaveHtml": { "title": "Save raw HTML (debugging)", "type": "boolean", "description": "Developer option: store the first few fetched pages in the key-value store.", "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 }, "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 } } } } } } } } } }