{ "openapi": "3.0.1", "info": { "title": "Etsy Scraper", "description": "Get full Etsy listing data by URL: price, sale price and discount, favorites, tags, images, variations and shop reviews, in any currency. Also pulls a shop's newest listings and finds listings by keyword through web search (not Etsy's own ranking).", "version": "0.0", "x-build-id": "PvADFuAolU8q9wl4o" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mina_safwat~etsy-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mina_safwat-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/mina_safwat~etsy-scraper/runs": { "post": { "operationId": "runs-sync-mina_safwat-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/mina_safwat~etsy-scraper/run-sync": { "post": { "operationId": "run-sync-mina_safwat-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": { "startUrls": { "title": "Etsy links", "type": "array", "description": "Etsy links, one per line: a listing (https://www.etsy.com/listing/1824319193/…, or just its number), a shop (https://www.etsy.com/shop/Linenia or linenia.etsy.com), or a search, category or market link (https://www.etsy.com/search?q=linen+apron, /c/accessories/aprons, /market/linen_apron). Search, category and market links are searched by their words, like the keywords below; the filters in them (price, sort, shipping) are not applied.", "default": [], "items": { "type": "string" } }, "searchQueries": { "title": "Search keywords", "type": "array", "description": "Words to find listings for, one search per line, such as linen apron. Each search returns up to \"Max listings per input\" listings whose address contains a word of your search, ranked by a web search of etsy.com (Yahoo Search), not by Etsy, because Etsy's own search pages block cloud servers; see the README.", "default": [], "items": { "type": "string" } }, "maxListings": { "title": "Max listings per input", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Stops after this many listings for each link or keyword. A shop gives its newest listings, 10 per shop section; a keyword gives up to about 250.", "default": 100 }, "skipUnavailable": { "title": "Skip listings not for sale", "type": "boolean", "description": "Leaves out sold-out, expired and other listings that cannot be bought now (no price, or not active), so you are not billed for them. Turn off to keep them; their price is then empty.", "default": true }, "includeDetails": { "title": "Add listing details", "type": "boolean", "description": "Adds the full description, materials, shop section and the variations (size, colour…) with each option's availability and price. When the price depends on the option, Etsy's open data does not give per-option prices, so they are left empty. Costs one extra request per listing.", "default": false }, "includeReviews": { "title": "Add the shop's newest reviews", "type": "boolean", "description": "Adds the newest reviews of each listing's shop (rating, text, date and the item reviewed). Etsy shows at most 6 per shop without the listing page; buyers' names are left out.", "default": false }, "maxReviewsPerListing": { "title": "Reviews per listing", "minimum": 0, "maximum": 6, "type": "integer", "description": "How many of the shop's newest reviews to add to each listing, up to 6.", "default": 6 }, "currency": { "title": "Currency", "type": "string", "description": "Prices are shown in this currency, as Etsy converts them for shoppers: a 3-letter code such as USD, EUR, GBP, CAD, AUD or JPY. Etsy falls back to US dollars for a currency it does not offer, and the log says so.", "default": "USD" }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Leave this empty: Etsy's listing data answers the Actor directly, and if it ever refuses, the Actor retries through Apify's datacenter and then residential proxies on its own. A proxy chosen here is used for Etsy only; keyword searches always go direct first and fall back to US residential proxies.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }