{ "openapi": "3.0.1", "info": { "title": "Etsy Scraper: Search Listings, In-Cart Counts, Ads & Tags", "description": "Scrape Etsy search results for any keyword: price, rank, ad slots, live in-cart counts, 24h sales, tags and each shop's total sales. Goes past Etsy's ~1,000-result limit per search. No login. Export to JSON, CSV or Excel.", "version": "0.0", "x-build-id": "ru8UMah5CATcfccCR" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/epicscrapers~etsy-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-epicscrapers-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/epicscrapers~etsy-scraper/runs": { "post": { "operationId": "runs-sync-epicscrapers-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/epicscrapers~etsy-scraper/run-sync": { "post": { "operationId": "run-sync-epicscrapers-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", "required": [ "queries" ], "properties": { "queries": { "title": "Search keywords", "type": "array", "description": "What a shopper would type in Etsy's search box, one search per entry (e.g. ceramic mug). An Etsy search URL also works; its q= keyword is used.", "items": { "type": "string" } }, "maxResultsPerQuery": { "title": "Max results per search", "minimum": 0, "type": "integer", "description": "Maximum listings saved per search. Etsy shows about 1,000 results per search; above that, the actor splits the search into price ranges to collect more. Set to 0 for no limit (can be hundreds of thousands for broad keywords).", "default": 100 }, "includeDetails": { "title": "Include listing details", "type": "boolean", "description": "Adds live in-cart count, sales in the last 24 hours, tags, favorites, shop name and total shop sales, ratings, variations and more. One extra request per listing, charged as a separate event. Turn off for the fastest, cheapest run with search-card data only (title, price, rating, rank, ad slot).", "default": true }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "newest", "price_asc", "price_desc", "top_reviews" ], "type": "string", "description": "Etsy's sort order. Relevance matches what shoppers see by default.", "default": "relevance" }, "minPrice": { "title": "Min price (USD)", "minimum": 0, "type": "integer", "description": "Only listings at or above this price in US dollars." }, "maxPrice": { "title": "Max price (USD)", "minimum": 0, "type": "integer", "description": "Only listings at or below this price in US dollars." }, "shipTo": { "title": "Ship to country", "pattern": "^([A-Za-z]{2})?$", "type": "string", "description": "Search as a shopper in this country (2-letter code, e.g. US, GB, DE). Etsy only shows listings that ship there. Prices stay in USD.", "default": "US" }, "shopLocation": { "title": "Shop location", "pattern": "^([A-Za-z]{2})?$", "type": "string", "description": "Only shops located in this country (2-letter code, e.g. US, GB). Leave empty for anywhere." }, "onSaleOnly": { "title": "On sale only", "type": "boolean", "description": "Only discounted listings.", "default": false }, "freeShippingOnly": { "title": "Free shipping only", "type": "boolean", "description": "Only listings with free shipping to the ship-to country.", "default": false }, "digitalOnly": { "title": "Digital downloads only", "type": "boolean", "description": "Only instant digital downloads.", "default": false }, "vintageOnly": { "title": "Vintage only", "type": "boolean", "description": "Only vintage items.", "default": false }, "personalizableOnly": { "title": "Personalizable only", "type": "boolean", "description": "Only listings that can be personalized.", "default": false }, "includeAds": { "title": "Include ads", "type": "boolean", "description": "Keep sponsored results (isAd is true, with their page and slot). Turn off to save only organic results.", "default": true }, "dedupeAcrossQueries": { "title": "Deduplicate across searches", "type": "boolean", "description": "Save each listing once per run even if several searches find it. Turn off to get every search's full result list, e.g. for rank tracking.", "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 } } } } } } } } } }