{ "openapi": "3.0.1", "info": { "title": "Shopee Reviews Scraper: Ratings, Photos, Seller Replies", "description": "Scrape Shopee product reviews by product link or shop and item id in 8 markets (SG, MY, TH, PH, VN, TW, ID, BR): star rating, text, date, reviewer name, variant bought, photos, video, sub ratings and seller reply, plus a free rating count row per product. Filter by stars, media or date. No login.", "version": "0.1", "x-build-id": "CVCspWts1KHcRGdJO" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/themineworks~shopee-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-themineworks-shopee-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/themineworks~shopee-reviews-scraper/runs": { "post": { "operationId": "runs-sync-themineworks-shopee-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/themineworks~shopee-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-themineworks-shopee-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": { "startUrls": { "title": "Shopee product links", "type": "array", "description": "One per line. A product link from SG, MY, TH, PH, VN, TW, ID or BR Shopee, for example https://shopee.sg/product/565089246/23614942861 or a link ending in -i.565089246.23614942861. You can also paste an id pair like 565089246.23614942861 (shop id, item id; the market comes from Country), or a shop link like https://shopee.sg/shop/565089246 for all of a shop's reviews. Up to 500 per run; products of the same shop are read together.", "items": { "type": "string" } }, "shopId": { "title": "Shop id (one product)", "type": "string", "description": "For one product at a time from Clay, n8n or an AI agent: the shop id, the first number in the product link. Use with Item id and Country. Leave Item id empty to get all of the shop's reviews." }, "itemId": { "title": "Item id (one product)", "type": "string", "description": "The item id: the second number in the product link, right after the shop id." }, "country": { "title": "Country (for ids)", "enum": [ "SG", "MY", "TH", "PH", "VN", "TW", "ID", "BR" ], "type": "string", "description": "The Shopee market of id pairs and of Shop id / Item id. Links carry their own market.", "default": "SG" }, "maxReviewsPerProduct": { "title": "Max reviews per product", "minimum": 0, "maximum": 5000, "type": "integer", "description": "The most reviews to return for each product (or shop link), newest first. 0 = every review Shopee serves. Example: 200.", "default": 100 }, "stars": { "title": "Star ratings", "type": "array", "description": "Only reviews with these star ratings. Leave empty for all. Pick 1 and 2 to collect complaints.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "enumTitles": [ "1 star", "2 stars", "3 stars", "4 stars", "5 stars" ] } }, "withMediaOnly": { "title": "Only reviews with photos or video", "type": "boolean", "description": "Skip reviews that have no buyer photo and no video.", "default": false }, "withCommentOnly": { "title": "Only reviews with written text", "type": "boolean", "description": "Skip star only ratings that have no comment.", "default": false }, "newerThan": { "title": "Only reviews newer than", "type": "string", "description": "Most recent reviews only: a date (2026-10-01) or an age (7 days, 2 weeks, 3 months). Reviews always come newest first and reading stops at the first older one. Good for a daily or weekly schedule." }, "includeSummary": { "title": "Summary row per product (free)", "type": "boolean", "description": "One extra row per product with the reviews found per star, with text, with photos and with a seller reply, the average and whether the counts are complete. Never charged.", "default": true }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify datacenter proxy by default, which works for Shopee's review feed. Residential is not needed.", "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 } } } } } } } } } }