{ "openapi": "3.0.1", "info": { "title": "๐Ÿš€ Shopee Shop Reviews Scraper ยท 5,000 Free Reviews/Month", "description": "Shopee Shop Reviews Scraper gets you buyer reviews โšก fast, ๐ŸŽฏ 100% accurate and ๐Ÿ” ridiculously detailed โ€” stars, text, sub-ratings, photos, product and seller reply. ๐Ÿ’ฐ $1 per 1,000 reviews, no start fee. Scrape your first 5,000 reviews free every month ๐Ÿš€", "version": "0.0", "x-build-id": "FOGne4Zr0I6KUN62Q" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/omkar-cloud~shopee-shop-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-omkar-cloud-shopee-shop-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/omkar-cloud~shopee-shop-reviews-scraper/runs": { "post": { "operationId": "runs-sync-omkar-cloud-shopee-shop-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/omkar-cloud~shopee-shop-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-omkar-cloud-shopee-shop-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", "required": [ "shops" ], "properties": { "shops": { "title": "๐Ÿช Shopee shops", "type": "array", "description": "Shopee shops, one per line: a username (apple.flagshipstore), a shop ID (442800909) or a shop link (https://shopee.sg/apple.flagshipstore). A link reads its own Shopee market.", "items": { "type": "string" } }, "country": { "title": "๐ŸŒ Shopee market", "enum": [ "sg", "my", "th", "vn", "ph", "id", "tw", "br", "mx" ], "type": "string", "description": "The Shopee site to read usernames and shop IDs from. Shop links always read their own site.", "default": "sg" }, "starRatings": { "title": "โญ Star ratings", "type": "array", "description": "Which star ratings to collect. Shopee lists shop reviews one star value at a time; each one is collected separately.", "items": { "type": "string", "enum": [ "5", "4", "3", "2", "1" ], "enumTitles": [ "5 stars", "4 stars", "3 stars", "2 stars", "1 star" ] }, "default": [ "5", "4", "3", "2", "1" ] }, "maxReviewsPerRating": { "title": "Maximum reviews per star rating", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop after this many reviews of each star rating for each shop. Shopee pages hold 20 reviews.", "default": 100 }, "maxResults": { "title": "Maximum reviews in total", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Stop the whole run after this many reviews. Keeps your cost predictable: 1,000 reviews โ‰ˆ $1.", "default": 1000 }, "onlyWithText": { "title": "Only reviews with text", "type": "boolean", "description": "Skip star-only reviews that have no written comment.", "default": false }, "onlyWithMedia": { "title": "Only reviews with photos or videos", "type": "boolean", "description": "Keep only reviews where the buyer attached photos or videos.", "default": false }, "reviewsSince": { "title": "Reviews since", "type": "string", "description": "Keep only reviews written on or after this date (YYYY-MM-DD). Paging stops at the first older review, so old shops stay cheap." }, "includeShopProfile": { "title": "๐Ÿช Add the shop's profile", "type": "boolean", "description": "Add the shop's name, rating, review count, followers, item count and response rate to every review row. One extra call per shop, no extra charge.", "default": true }, "onlyNewReviews": { "title": "๐Ÿ” Only new reviews", "type": "boolean", "description": "Monitoring mode: skip reviews this Actor already delivered for the same shops in earlier runs, so a scheduled run returns (and bills) only reviews written since.", "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 }, "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 } } } } } } } } } }