{ "openapi": "3.0.1", "info": { "title": "Etsy Scraper - Listings, Prices and Shops", "description": "Scrape Etsy category listings: item name, price, currency, availability, seller shop, image and URL. Reads the JSON-LD the category page publishes and pages through automatically.", "version": "0.2", "x-build-id": "0UBUESzwYvaKSsO23" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/s-r~etsy-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-s-r-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/s-r~etsy-scraper/runs": { "post": { "operationId": "runs-sync-s-r-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/s-r~etsy-scraper/run-sync": { "post": { "operationId": "run-sync-s-r-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": { "queries": { "title": "Search terms", "type": "array", "description": "What to search Etsy for, one term per line. Every term is run separately and the results are pooled. Leave empty only if you are using a category URL instead.", "default": [ "leather bag" ], "items": { "type": "string" } }, "category": { "title": "Category to search inside", "enum": [ "all", "accessories", "art-and-collectibles", "bags-and-purses", "bath-and-beauty", "books-movies-and-music", "clothing", "craft-supplies-and-tools", "electronics-and-accessories", "home-and-living", "jewelry", "paper-and-party-supplies", "pet-supplies", "shoes", "toys-and-games", "weddings" ], "type": "string", "description": "Narrows the search to one Etsy department. Leave it on 'all' to search the whole site. A department Etsy does not recognise falls back to 'all' rather than failing the run.", "default": "all" }, "max_results": { "title": "Maximum listings", "minimum": 1, "maximum": 5000, "type": "integer", "description": "How many listings to return in total across every search term. Etsy's search grid carries 12 listings per page, so 120 listings is 10 pages.", "default": 120 }, "max_pages": { "title": "Maximum pages per search term", "minimum": 1, "maximum": 50, "type": "integer", "description": "Stops each search term after this many pages even if the listing target has not been reached. 12 listings per page.", "default": 20 }, "country": { "title": "Country to price in", "enum": [ "us", "gb", "ca", "au", "de", "fr", "nl", "es", "it", "ie", "nz", "se", "pl" ], "type": "string", "description": "Two-letter country code. Etsy prices off the visitor's location, so this is what decides the currency: a GB request came back with every price in GBP, a US request in USD. It does not restrict which sellers appear.", "default": "us" }, "min_price": { "title": "Minimum price", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Drops listings below this price, in the currency the country setting selects. Etsy applies this itself: a minimum of 200 returned prices from 204.75 up, against a 12.24 floor with the filter off." }, "max_price": { "title": "Maximum price", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Drops listings above this price, in the currency the country setting selects. Etsy applies this itself: a maximum of 25 returned nothing above 24.79, against a 230.00 ceiling with the filter off." }, "digital_only": { "title": "Digital downloads only", "type": "boolean", "description": "Returns only instant-download items such as patterns, printables and templates. Etsy applies this itself: with it on, 12 of 12 rows carried a download badge, against 0 of 12 with it off.", "default": false }, "on_sale_only": { "title": "On sale only", "type": "boolean", "description": "Keeps only listings showing a discount badge. This is applied to the rows after they are read, because Etsy's own on-sale filter returned the same listings reshuffled when it was measured. The badge it reads is the one printed on the listing, so the discount_percent field proves every kept row.", "default": false }, "free_shipping_only": { "title": "Free shipping only", "type": "boolean", "description": "Keeps only listings showing a free-shipping badge. Applied to the rows after they are read, for the same reason as the on-sale filter: Etsy's own version did not narrow the result set when measured. The free_shipping field proves every kept row.", "default": false }, "include_ads": { "title": "Include promoted listings", "type": "boolean", "description": "Etsy fills about half of every search page with paid placements. Leave this on to keep them, tagged with is_ad true, or turn it off to return only organic results.", "default": true }, "dedupe_across_queries": { "title": "Remove duplicates across search terms", "type": "boolean", "description": "Returns a listing once even when several search terms find it. Turn it off to see which terms a listing ranks for, since every row carries the query that found it.", "default": true }, "category_url": { "title": "Category URL (instead of a search term)", "type": "string", "description": "An Etsy category page such as https://www.etsy.com/c/jewelry, for browsing a department rather than searching it. Ignored when search terms are given. Shop and listing URLs are refused: Etsy answers 403 to those from every exit tested." }, "retries": { "title": "Retries per page", "minimum": 1, "maximum": 10, "type": "integer", "description": "Etsy refuses about one request in eight regardless of pacing. Each retry uses a fresh exit IP, so retries are how pages get through rather than a sign of trouble.", "default": 5 } } }, "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 } } } } } } } } } }