{ "openapi": "3.0.1", "info": { "title": "Etsy Product & Shop Scraper", "description": "Scrape Etsy search results and shop listings. Extracts title, price, original price, discount, rating, reviews, free shipping, seller, images, tags, materials, and categories. Filter by price, shipping, and rating. Optionally visit each listing for full details.", "version": "0.1", "x-build-id": "mVagO1BhfriOOacvJ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/rupom888~etsy-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-rupom888-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/rupom888~etsy-scraper/runs": { "post": { "operationId": "runs-sync-rupom888-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/rupom888~etsy-scraper/run-sync": { "post": { "operationId": "run-sync-rupom888-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", "properties": { "scrapeType": { "title": "Scrape Type", "enum": [ "search", "shop" ], "type": "string", "description": "Search for listings by keyword, or scrape a specific Etsy shop.", "default": "search" }, "keywords": { "title": "Search Keywords", "type": "array", "description": "Keywords to search on Etsy (e.g. 'personalized jewelry', 'macrame wall hanging').", "items": { "type": "string" } }, "shopUrls": { "title": "Shop URLs", "type": "array", "description": "Etsy shop URLs to scrape all listings from. Used for Shop Listings type.", "items": { "type": "string" } }, "resultsPerKeyword": { "title": "Results Per Keyword / Shop", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Max listings to scrape per keyword or shop.", "default": 25 }, "sortBy": { "title": "Sort By", "enum": [ "relevance", "recent", "price_low", "price_high", "top_reviews" ], "type": "string", "description": "Sort order for search results.", "default": "relevance" }, "minPrice": { "title": "Minimum Price ($)", "minimum": 0, "type": "integer", "description": "Filter listings with price at or above this value. Set 0 to disable.", "default": 0 }, "maxPrice": { "title": "Maximum Price ($)", "minimum": 0, "type": "integer", "description": "Filter listings with price at or below this value. Set 0 to disable.", "default": 0 }, "minRating": { "title": "Minimum Rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Filter listings with rating at or above this value (1-5). Set 0 to disable.", "default": 0 }, "freeShipping": { "title": "Free Shipping Only", "type": "boolean", "description": "Only return listings with free shipping.", "default": false }, "category": { "title": "Category Filter", "type": "string", "description": "Restrict results to a specific Etsy category slug (e.g. 'jewelry', 'home-and-living')." }, "scrapeListingDetail": { "title": "Scrape Full Listing Details", "type": "boolean", "description": "Visit each listing page for full description, tags, materials, images, and shop stats. Slower but richer.", "default": false }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Residential proxy recommended for Etsy scraping at scale." } } }, "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 } } }, "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 } } } } } } } } } }