{ "openapi": "3.0.1", "info": { "title": "TikTok Shop Review Scraper - All 16 Marketplaces", "description": "Extract every buyer review from any TikTok Shop product: star rating, full text, date, photos, the variant bought and verified-purchase flags. Works across all 16 marketplaces, not just the US, and adds a free product summary with price, shop data and the 1-5 star breakdown.", "version": "0.0", "x-build-id": "HCbVi6DuivpQGClW2" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/zen-studio~tiktok-shop-review-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-zen-studio-tiktok-shop-review-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/zen-studio~tiktok-shop-review-scraper/runs": { "post": { "operationId": "runs-sync-zen-studio-tiktok-shop-review-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/zen-studio~tiktok-shop-review-scraper/run-sync": { "post": { "operationId": "run-sync-zen-studio-tiktok-shop-review-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": "Product URLs", "maxItems": 500, "type": "array", "description": "TikTok Shop product pages to collect reviews from. Takes precedence over Product IDs and Search keyword.", "items": { "type": "string" } }, "productIds": { "title": "Product IDs", "maxItems": 500, "type": "array", "description": "Numeric product IDs, if you already have them. Used when no Product URLs are given.", "items": { "type": "string" } }, "searchKeyword": { "title": "Search keyword", "type": "string", "description": "Find products by keyword and collect reviews for the matches. Used only when no Product URLs or Product IDs are given." }, "maxProductsFromSearch": { "title": "Max products from search", "minimum": 1, "maximum": 100, "type": "integer", "description": "How many matching products to collect reviews for. Only used when you scrape by search keyword." }, "region": { "title": "Marketplace", "enum": [ "US", "GB", "DE", "FR", "IT", "ES", "IE", "BR", "MX", "JP", "ID", "MY", "PH", "SG", "TH", "VN" ], "type": "string", "description": "Which TikTok Shop marketplace the products belong to. Reviews are written in that market's language." }, "maxReviewsPerProduct": { "title": "Max reviews per product", "minimum": 1, "type": "integer", "description": "Upper limit of reviews collected per product. Leave empty to collect every review available. You are charged per review returned, so this is also your cost control." }, "reviewsFilter": { "title": "Only include", "enum": [ "all", "5_star", "4_star", "3_star", "2_star", "1_star", "with_images", "verified" ], "type": "string", "description": "Keep only reviews matching this condition. Filtered runs scan more pages to find matches and may return fewer reviews than the maximum." }, "reviewsSort": { "title": "Sort reviews by", "enum": [ "recommended", "most_recent", "highest_rating", "lowest_rating" ], "type": "string", "description": "Order of the collected reviews. Sorting is applied to the reviews this run collects, not to the product's entire review history." }, "includeProductSummary": { "title": "Include product summary row", "type": "boolean", "description": "Adds one free row per product with its title, price, average rating, total review count and shop details, and fills the product title in on every review row. Product and shop details are available for the United States marketplace.", "default": true }, "includeRatingBreakdown": { "title": "Include star breakdown", "type": "boolean", "description": "Adds the full 1-5 star distribution to the product summary row. Adds a few seconds per product and is skipped silently if unavailable.", "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 } } } } } } } } } }