{ "openapi": "3.0.1", "info": { "title": "Etsy Listings Scraper - Prices, Shops, Ads, Ranks & Details", "description": "Scrape Etsy listings by keyword, category or listing URL: price, sale, shop, rating, Star Seller and Etsy's Pick badges, ads and organic rank, in 26 Etsy marketplaces. Optional listing-page details: description, photos, favorites, stock, variations, shop sales, buyer search terms. No login.", "version": "0.1", "x-build-id": "m0dBkX95aZNXK0IdV" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapersdelight~etsy-listings-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapersdelight-etsy-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/scrapersdelight~etsy-listings-scraper/runs": { "post": { "operationId": "runs-sync-scrapersdelight-etsy-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/scrapersdelight~etsy-listings-scraper/run-sync": { "post": { "operationId": "run-sync-scrapersdelight-etsy-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": { "queries": { "title": "Keywords", "type": "array", "description": "What to search on Etsy, as a buyer would type it, e.g. \"ceramic mug\", \"linen apron\", \"personalized dog collar\". Each line is its own search.", "items": { "type": "string" } }, "categories": { "title": "Categories", "type": "array", "description": "Etsy category paths or /c/ URLs, e.g. \"home-and-living/kitchen-and-dining\", \"jewelry/rings\" or https://www.etsy.com/c/art-and-collectibles. 60+ listings per page, shop names included.", "items": { "type": "string" } }, "startUrls": { "title": "Etsy URLs", "type": "array", "description": "Etsy search, market, category or listing URLs, e.g. https://www.etsy.com/search?q=linen+apron or https://www.etsy.com/uk/market/tea_towel. URL filters are kept; shop pages are not supported.", "items": { "type": "string" } }, "listingUrls": { "title": "Listing URLs or ids", "type": "array", "description": "Look up single listings: listing URLs or ids, e.g. https://www.etsy.com/listing/1017209660/... or 4589157848. Each one is read from its listing page (billed with the details add-on).", "items": { "type": "string" } }, "marketplace": { "title": "Etsy marketplace", "enum": [ "US", "GB", "CA", "AU", "NZ", "IE", "DE", "FR", "IT", "ES", "NL", "BE", "AT", "CH", "PT", "PL", "DK", "FI", "NO", "SE", "IN", "SG", "HK", "IL", "JP", "MX" ], "type": "string", "description": "Which Etsy country site to read: prices, currency and delivery estimates follow it. A pasted URL keeps its own country.", "default": "US" }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "price_asc", "price_desc", "top_reviews", "newest" ], "type": "string", "description": "Order of the results.", "default": "relevance" }, "minPrice": { "title": "Min price", "minimum": 0, "maximum": 1000000, "type": "number", "description": "Lowest price, in the marketplace currency, e.g. 20." }, "maxPrice": { "title": "Max price", "minimum": 0, "maximum": 1000000, "type": "number", "description": "Highest price, in the marketplace currency, e.g. 60." }, "shipTo": { "title": "Ships to", "pattern": "^([A-Za-z]{2})?$", "type": "string", "description": "Only listings that ship to this country: a two-letter code, e.g. US, GB, DE. Keyword searches only." }, "readyToShipWithin": { "title": "Ready to ship within", "enum": [ "1", "3" ], "type": "string", "description": "Only listings the seller dispatches within this many days. Empty = any." }, "freeShippingOnly": { "title": "Free shipping only", "type": "boolean", "description": "Only listings with free shipping.", "default": false }, "onSaleOnly": { "title": "On sale only", "type": "boolean", "description": "Only listings with a sale price.", "default": false }, "starSellerOnly": { "title": "Star Sellers only", "type": "boolean", "description": "Only listings from Star Seller shops.", "default": false }, "bestsellerOnly": { "title": "Bestsellers only", "type": "boolean", "description": "Only listings with Etsy's Bestseller badge.", "default": false }, "etsysPickOnly": { "title": "Etsy's Picks only", "type": "boolean", "description": "Only listings Etsy's editors picked.", "default": false }, "handmadeOnly": { "title": "Handmade only", "type": "boolean", "description": "Only handmade listings.", "default": false }, "digitalOnly": { "title": "Digital downloads only", "type": "boolean", "description": "Only instant-download listings.", "default": false }, "personalizableOnly": { "title": "Personalizable only", "type": "boolean", "description": "Only listings that take personalization.", "default": false }, "includeAds": { "title": "Include ads", "type": "boolean", "description": "Keep the paid ad slots Etsy mixes into the results (each row says isAd and its ad slot). Off = organic results only.", "default": true }, "includeKeywords": { "title": "Title must contain", "type": "array", "description": "Keep a listing only if its title contains at least one of these words, e.g. \"stoneware\".", "items": { "type": "string" } }, "excludeKeywords": { "title": "Title must not contain", "type": "array", "description": "Drop listings whose title contains any of these words, e.g. \"digital\", \"svg\".", "items": { "type": "string" } }, "minShopRating": { "title": "Min shop rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Only shops rated at least this many stars (0-5), e.g. 4.8." }, "minShopReviews": { "title": "Min shop reviews", "minimum": 0, "maximum": 10000000, "type": "integer", "description": "Only shops with at least this many reviews, e.g. 100." }, "minFavorites": { "title": "Min favorites", "minimum": 0, "maximum": 10000000, "type": "integer", "description": "Only listings favorited at least this many times. Favorites are on the listing page, so this reads it for each candidate and kept rows carry (and bill) the details add-on." }, "includeDetails": { "title": "Add listing-page details", "type": "boolean", "description": "Description, all photos, video, favorites, quantity, variations, materials, item rating and latest reviews, shipping and returns, shop sales and years on Etsy, buyer search terms.", "default": false }, "monitorMode": { "title": "Only new or re-priced listings", "type": "boolean", "description": "Deliver only listings not delivered by an earlier run with the same searches, plus listings whose price changed (changeType, previousPrice).", "default": false }, "monitorKey": { "title": "Monitor name", "type": "string", "description": "Optional name for the monitor's memory, e.g. \"mugs-daily\". Empty = one memory per set of searches and filters." }, "maxItems": { "title": "Max listings", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Total listings to deliver across all inputs. A results page holds about 60 listings.", "default": 100 }, "maxItemsPerQuery": { "title": "Max listings per search", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Cap for each keyword, category or URL; 0 = no per-search cap.", "default": 0 }, "maxPagesPerQuery": { "title": "Max pages per search", "minimum": 0, "maximum": 250, "type": "integer", "description": "Stop each search after this many results pages; 0 = no page cap.", "default": 0 }, "compact": { "title": "Compact output", "type": "boolean", "description": "Core fields only (id, title, price, shop, rating, rank, badges, favorites) - trimmed for AI/MCP pipelines.", "default": false }, "descriptionMaxLength": { "title": "Description max length", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Trim the listing description to this many characters; 0 = full text.", "default": 0 }, "maxConcurrency": { "title": "Pages in flight", "minimum": 1, "maximum": 10, "type": "integer", "description": "Pages loaded at the same time.", "default": 4 }, "useUnblockerFallback": { "title": "Unblocker fallback", "type": "boolean", "description": "When Etsy refuses a page on two residential exits, try it once through Apify's Unblocker before giving up on it.", "default": true }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Etsy serves residential exits (the run picks one in the marketplace's country). You can also give your own proxy URLs.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }