{ "openapi": "3.0.1", "info": { "title": "Etsy Reviews Scraper", "description": "Scrape Etsy product reviews from listing URLs and shop pages. Extract rating, review text, reviewer, date, images, listing metadata, and shop context for sentiment analysis, competitor research, and AI agents.", "version": "1.0", "x-build-id": "Cln0S0oROZSe0FkZT" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/khadinakbar~etsy-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-khadinakbar-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/khadinakbar~etsy-reviews-scraper/runs": { "post": { "operationId": "runs-sync-khadinakbar-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/khadinakbar~etsy-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-khadinakbar-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": { "productUrls": { "title": "Etsy Product URLs", "type": "array", "description": "Use this when you have direct Etsy listing URLs to collect reviews from. Enter one URL per line, for example https://www.etsy.com/listing/1071878058/charger-plate-pumpkin-set-pumpkin. Defaults to one sample listing when no input is provided. Do not use search result URLs here; use shopUrls only for Etsy shop pages.", "items": { "type": "string" } }, "shopUrls": { "title": "Etsy Shop URLs", "type": "array", "description": "Use this when you want the actor to discover listings from Etsy shop pages before scraping reviews. Enter full shop URLs such as https://www.etsy.com/shop/GlassMystique. Defaults to empty and is slower than direct listing URLs. This is not a keyword search field.", "default": [], "items": { "type": "string" } }, "maxReviewsPerListing": { "title": "Max Reviews Per Listing", "minimum": 1, "maximum": 500, "type": "integer", "description": "Use this to cap the number of reviews collected from each Etsy listing. Accepts integers from 1 to 500, with 25 as the default. Lower this for quick sentiment samples and raise it for deeper product research. This does not cap the total run across all listings; use maxResults for that.", "default": 25 }, "maxResults": { "title": "Max Total Reviews", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Use this to cap the total number of review records saved across the whole run. Accepts integers from 1 to 5000, with 25 as the default. The actor stops before charging beyond this cap. This is a review count, not a page count.", "default": 25 }, "sortBy": { "title": "Review Sort Order", "enum": [ "most_recent", "recommended" ], "type": "string", "description": "Use this to prefer newest Etsy reviews or Etsy's recommended order. Choose most_recent for monitoring fresh feedback, or recommended for Etsy's default display. Defaults to most_recent. This does not filter by star rating.", "default": "most_recent" }, "includeListingMetadata": { "title": "Include Listing Metadata", "type": "boolean", "description": "Use this to include listing title, shop name, listing rating, and review count on each review row. Defaults to true because agents and analysts need product context with each review. Disable it only when you need the smallest possible rows. This does not scrape full product descriptions.", "default": true }, "includeReviewImages": { "title": "Include Review Images", "type": "boolean", "description": "Use this to include image URLs attached to customer reviews when Etsy exposes them. Defaults to true for richer quality and UGC analysis. Disable it to reduce output size. This does not download image files; it only returns URLs.", "default": 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 } } }, "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 } } } } } } } } } }