{ "openapi": "3.0.1", "info": { "title": "Etsy Scraper", "description": "Scrape Etsy listings by keyword, category, shop or link: title, price, discount, shop, ratings, reviews count, favorites, photos, variations, materials, shipping and badges, plus shop details and shop reviews. No login.", "version": "0.1", "x-build-id": "7eT0RoqVB6a5rD5oC" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automly~etsy-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automly-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/automly~etsy-scraper/runs": { "post": { "operationId": "runs-sync-automly-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/automly~etsy-scraper/run-sync": { "post": { "operationId": "run-sync-automly-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": { "searchQueries": { "title": "Search keywords", "type": "array", "description": "Enter what to search Etsy for, one per line (\"ceramic mug\", \"personalized necklace\"). Each keyword gives its own list of listings, filtered by the options below.", "items": { "type": "string" } }, "startUrls": { "title": "Etsy links", "type": "array", "description": "Paste Etsy links in any mix: search pages (etsy.com/search?q=...), category pages (etsy.com/c/...), shops (etsy.com/shop/...), listings (etsy.com/listing/...) and etsy.me short links. Country versions (etsy.com/uk/..., /de/...) work too. A listing ID or a shop name on its own works as well.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Max listings per search, category or shop", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "How many listings to save from each keyword, search link, category or shop. Set 0 for all of them (Etsy shows up to about 250 pages of a search).", "default": 50 }, "includeDetails": { "title": "Include full listing details", "type": "boolean", "description": "Open every listing for its description, all photos, variations, materials, highlights, favorites, item rating and review count, shipping, delivery estimate, return policy, category and listing date. Turn off for a faster, cheaper list with title, price, discount, shop, shop rating, image and badges. Listing links always get full details.", "default": true }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "price_asc", "price_desc", "newest", "top_reviews" ], "type": "string", "description": "The order of search results (keywords and search links).", "default": "relevance" }, "minPrice": { "title": "Min price", "minimum": 0, "type": "integer", "description": "Only listings that cost at least this much (in the currency below)." }, "maxPrice": { "title": "Max price", "minimum": 0, "type": "integer", "description": "Only listings that cost at most this much (in the currency below)." }, "shipTo": { "title": "Ships to country", "type": "string", "description": "A two-letter country code (US, GB, DE, CA, AU, ...): only listings that ship there." }, "freeShipping": { "title": "Free shipping only", "type": "boolean", "description": "Only listings with free shipping.", "default": false }, "currency": { "title": "Currency", "enum": [ "USD", "EUR", "GBP", "CAD", "AUD", "JPY", "INR", "CHF", "SEK", "NOK", "DKK", "PLN", "NZD", "MXN", "SGD", "HKD", "ILS", "BRL", "TRY", "ZAR" ], "type": "string", "description": "The currency prices are shown in.", "default": "USD" }, "includeReviews": { "title": "Include shop reviews", "type": "boolean", "description": "Also save the reviews of each shop you give (and of the shop of each listing link): rating, text, date, reviewer, the item bought and the seller's reply.", "default": false }, "maxReviews": { "title": "Max reviews per shop", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "How many reviews to save for each shop, newest first. Set 0 for all of them.", "default": 100 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy works out of the box.", "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 } } } } } } } } } }