{ "openapi": "3.0.1", "info": { "title": "Etsy Reviews Scraper: Get Every Review via Official API", "description": "Pull EVERY review from an Etsy shop or listing through Etsy’s official Open API. No scraping, so no DataDome blocks and no captchas — and no “8 reviews out of 3,000”. Returns Etsy’s own review count so you can check the pull was complete. Reviews we cannot return are never charged.", "version": "0.1", "x-build-id": "6dWteP1fpRtKtXExG" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/wheaten_steelpan~etsy-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-wheaten_steelpan-etsy-reviews-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/wheaten_steelpan~etsy-reviews-scraper/runs": { "post": { "operationId": "runs-sync-wheaten_steelpan-etsy-reviews-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/wheaten_steelpan~etsy-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-wheaten_steelpan-etsy-reviews-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": { "shopNames": { "title": "Etsy shop names (exact spelling)", "type": "array", "description": "One or more Etsy shop names, spelled exactly as Etsy spells them. You can find the name in the shop's web address, for example etsy.com/shop/FreedomMockups gives you FreedomMockups. It never contains spaces, and it is often different from the large title at the top of the shop page. Upper and lower case do not matter, but the spelling has to match, because this Actor will not guess between similar shops. A name that does not match stops the run and lists the closest real shop names for you. Every review the shop has is available. Use Max reviews per shop below if you want fewer.", "items": { "type": "string" } }, "listingIds": { "title": "Etsy listing IDs or URLs (optional)", "type": "array", "description": "Pull reviews for specific listings instead of, or alongside, whole shops. Accepts a listing ID (1234567890) or a full listing URL.", "items": { "type": "string" } }, "itemLimit": { "title": "Max reviews per shop or listing (optional)", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Leave blank to pull EVERY review. That is the default, and it is what this Actor is for. Set a number only if you want to spend less: the median Etsy shop holds about 1,800 reviews and large shops run past 15,000, and each review returned is charged. Reviews that cannot be returned are never charged." }, "textOnly": { "title": "Skip reviews with no text", "type": "boolean", "description": "Etsy lets a buyer leave stars without writing anything. Tick this to leave those out. You are not charged for them. Measured across 16 real shops: about 5% of reviews are star-only, usually 0-3%, but two shops in the sample were 22% and 33%. Leave it off to get every review, including ratings with no words.", "default": 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 } } }, "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 } } } } } } } } } }