{ "openapi": "3.0.1", "info": { "title": "Etsy Products & Listings Scraper (Search, Shop, Category)", "description": "Scrape Etsy products from keywords, search, category, shop and listing URLs: title, price, sale, shop, ratings, badges, images. Free price summary per search or shop: median, quartiles, share on sale, top shops. Details add favorites, description, stock. $1 per 1,000, +$3.40 with details.", "version": "1.0", "x-build-id": "3cEIrGcouPLnEhp8s" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/heyitsgautham~etsy-products-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-heyitsgautham-etsy-products-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/heyitsgautham~etsy-products-scraper/runs": { "post": { "operationId": "runs-sync-heyitsgautham-etsy-products-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/heyitsgautham~etsy-products-scraper/run-sync": { "post": { "operationId": "run-sync-heyitsgautham-etsy-products-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": "Each keyword runs an Etsy search, the same as typing it into the Etsy search box.", "items": { "type": "string" } }, "startUrls": { "title": "Etsy URLs", "type": "array", "description": "Search, category (/c/...), market, shop or listing URLs. Filters already in a search or category URL are kept.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Max products per keyword or URL", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Stops each keyword or URL after this many products. A listing URL always returns one product. Etsy shows at most about 20 pages (around 900 products) for one search.", "default": 50 }, "includeDetails": { "title": "Open each listing page", "type": "boolean", "description": "Adds the full description, all images, listing rating and review count, favorites, materials, category, stock, shipping cost, ships-from, listed date, badges and shop name. Slower, about 1 to 3 seconds per product. Listing URLs always get these details.", "default": false }, "priceSummary": { "title": "Add a free price summary row per keyword or URL", "type": "boolean", "description": "Adds one free row with status summary for each keyword, search, market, category or shop URL. It gives the price count, min, quartiles, median, max and average, the share on sale, with free shipping and from Star Sellers, and the top shops by listing count. With listing details on, it also gives favorites, favorites by price quarter, listing reviews, rating and shipping cost. It is worked out from the products already returned, so it adds no requests and no charge.", "default": false }, "sortBy": { "title": "Sort by", "enum": [ "most_relevant", "price_asc", "price_desc", "date_desc", "highest_reviews" ], "type": "string", "description": "Order for keyword searches and category pages.", "default": "most_relevant" }, "minPrice": { "title": "Min price", "minimum": 0, "type": "integer", "description": "In the currency below." }, "maxPrice": { "title": "Max price", "minimum": 0, "type": "integer", "description": "In the currency below." }, "shipsTo": { "title": "Ships to", "type": "string", "description": "Two-letter country code such as US, GB, DE or AU. Only returns items that ship there. Leave empty for no shipping filter (prices and free-shipping flags then follow the US)." }, "freeShipping": { "title": "Free shipping only", "type": "boolean", "description": "Only items with free shipping to the country above.", "default": false }, "currency": { "title": "Currency", "type": "string", "description": "Three-letter code for prices, such as USD, EUR, GBP, CAD or AUD.", "default": "USD" }, "includeAds": { "title": "Include sponsored listings", "type": "boolean", "description": "Etsy mixes paid ads into results. Off by default. When on, ad rows have isAd set to true.", "default": false }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many requests run in parallel.", "default": 10 }, "useProxy": { "title": "Use residential proxy", "type": "boolean", "description": "Leave on. Etsy blocks data-center IPs.", "default": true } } }, "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 } } } } } } } } } }