{ "openapi": "3.0.1", "info": { "title": "Shopee Reviews Scraper - Ratings & Comments in 8 Countries", "description": "Scrape Shopee reviews of any shop or product in Singapore, Brazil, Indonesia, Malaysia, Thailand, Philippines, Vietnam and Taiwan: stars, comment, variation, quality, service and delivery scores, seller reply, photo and video counts. Up to 5,000 per shop. No login. Error rows are free.", "version": "0.1", "x-build-id": "HFQSlhvYwilcaguAW" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapewise~shopee-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapewise-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/scrapewise~shopee-reviews-scraper/runs": { "post": { "operationId": "runs-sync-scrapewise-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/scrapewise~shopee-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-scrapewise-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 shop or product links", "type": "array", "description": "Shop links (https://shopee.sg/shop/64922680 or https://shopee.sg/) or product links (https://shopee.sg/product// or any ...-i.. link), from any of the 8 countries. A shop returns its newest reviews across all products; a product returns only its own reviews (read from its shop's reviews, see 'Max reviews'). Also accepts 'urls', 'productUrls', 'shopUrls' and 'url'.", "items": { "type": "string" } }, "shopIds": { "title": "Shops by id or username", "type": "array", "description": "Numeric shop ids (64922680) or shop usernames (ugreen.sg). Uses the Country below. Also accepts 'shops'.", "items": { "type": "string" } }, "country": { "title": "Country", "enum": [ "SG", "BR", "ID", "MY", "TH", "PH", "VN", "TW" ], "type": "string", "description": "Shopee country for shop ids and usernames. Links always use the country of their own domain.", "default": "SG" }, "maxReviews": { "title": "Max reviews per shop or product", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Reviews delivered per input, newest first. The most you can get from one shop is 5,000. For a product, the Actor reads its shop's reviews (up to that same limit) and keeps the ones of that product: a product of a very large shop may have fewer reviews in reach.", "default": 100 }, "minRating": { "title": "Min stars", "minimum": 1, "maximum": 5, "type": "integer", "description": "Only reviews with at least this many stars (1 to 5). Set min 1 and max 2 to get only complaints.", "default": 1 }, "maxRating": { "title": "Max stars", "minimum": 1, "maximum": 5, "type": "integer", "description": "Only reviews with at most this many stars (1 to 5). Filtering by stars reaches further back in time.", "default": 5 }, "onlyWithComment": { "title": "Only reviews with a written comment", "type": "boolean", "description": "Skip star-only reviews. Skipped reviews are not charged.", "default": false }, "onlyWithMedia": { "title": "Only reviews with photos or videos", "type": "boolean", "description": "Keep only reviews where the buyer attached at least one photo or video. The output has the counts, not the files.", "default": false }, "newerThan": { "title": "Only reviews newer than", "type": "string", "description": "A date (2026-09-01) or a period (30 days, 2 weeks, 6 months). Reading stops at the first older review, so a daily or weekly schedule only pays for what is new." }, "includeShopSummary": { "title": "Add a shop summary row", "type": "boolean", "description": "Adds one free row (type 'shop') per shop: name, username, link, shop rating, total reviews split into good / normal / bad, followers, products, response rate, official badge and join date.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify Proxy by default, with a stronger proxy as a fallback when a request is refused.", "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 } } } } } } } } } }