{ "openapi": "3.0.1", "info": { "title": "Etsy Bestsellers & Tags Scraper", "description": "Extract Etsy listings with bestseller & star seller badges, real discounts, ratings, SEO keyword tags, shop info and prices. No login, export to CSV/Excel/JSON.", "version": "0.1", "x-build-id": "A35auFbzp6i3XwWPM" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/magic-scraper~etsy-bestsellers-tags-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-magic-scraper-etsy-bestsellers-tags-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/magic-scraper~etsy-bestsellers-tags-scraper/runs": { "post": { "operationId": "runs-sync-magic-scraper-etsy-bestsellers-tags-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/magic-scraper~etsy-bestsellers-tags-scraper/run-sync": { "post": { "operationId": "run-sync-magic-scraper-etsy-bestsellers-tags-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": "Keywords or search phrases to find products on Etsy (e.g. 'minimalist wall art', 'leather wallet').", "items": { "type": "string" } }, "listingUrls": { "title": "🔗 Direct Etsy Listing URLs (Optional)", "type": "array", "description": "Paste specific Etsy listing URLs or numeric listing IDs (e.g. 'https://www.etsy.com/listing/4494184279/...'). Each returns the same fields as a search result, including tags.", "items": { "type": "string" } }, "maxResultsPerQuery": { "title": "💯 Max Listings per Keyword", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of listings to collect for each search keyword.", "default": 30 }, "sortBy": { "title": "🎯 Sort Order", "enum": [ "most_relevant", "price_asc", "price_desc", "newest" ], "type": "string", "description": "Sorting criteria for Etsy search results.", "default": "most_relevant" }, "countryCode": { "title": "🌍 Ship-to Country Market", "enum": [ "US", "GB", "CA", "AU", "DE", "FR" ], "type": "string", "description": "Country of the residential IP Etsy sees: search ranking, prices and free-shipping flags follow this market.", "default": "US" }, "bestsellersOnly": { "title": "🏆 Filter: Bestsellers Only", "type": "boolean", "description": "If enabled, only listings with the official Etsy Bestseller badge will be saved.", "default": false }, "onSaleOnly": { "title": "🏷️ Filter: On-Sale Items Only", "type": "boolean", "description": "If enabled, only listings with active discounts will be saved.", "default": false }, "freeShippingOnly": { "title": "🚚 Filter: Free Shipping Only", "type": "boolean", "description": "If enabled, only listings offering free shipping will be saved.", "default": false }, "proxyConfiguration": { "title": "🌐 Proxy Configuration", "type": "object", "description": "Etsy blocks datacenter and cloud-server IPs, so with Apify Proxy on the Actor uses the RESIDENTIAL group in the selected country (unless you pick other groups or your own proxy URLs). Residential traffic is already included in the price per result. Without a residential proxy Etsy answers 403 and nothing is saved.", "default": { "useApifyProxy": 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 } } } } } } } } } }