{ "openapi": "3.0.1", "info": { "title": "TikTok Shop Review Scraper — Ratings & Photos", "description": "Scrape TikTok Shop product reviews by product URL or keyword across 10 storefronts, Indonesia included. Each row carries rating, review_text, review_time, reviewer_name, sku_specification, is_verified_purchase and image_urls. Filter by star rating. Export JSON, CSV or Excel.", "version": "0.1", "x-build-id": "cWfoV0rHJWaNNaukE" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/herus13~tiktok-shop-review-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-herus13-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/herus13~tiktok-shop-review-scraper/runs": { "post": { "operationId": "runs-sync-herus13-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/herus13~tiktok-shop-review-scraper/run-sync": { "post": { "operationId": "run-sync-herus13-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", "type": "array", "description": "Product page URLs to pull reviews from, one per entry. Most regions: `https://shop.tiktok.com/{region}/pdp/{slug}/{product_id}`. For `ID` (Indonesia, served by Tokopedia): `https://www.tokopedia.com/{shop}/{product-slug}`. Give at least one of productUrls or searchTerms; leave empty to take products from searchTerms only.", "items": { "type": "string" } }, "searchTerms": { "title": "Search terms", "type": "array", "description": "Keywords to search the storefront for. The top products of each search (see maxProductsPerSearch) are looked up and their reviews returned; the products themselves are not rows. Examples: `wireless earbuds`, `serum`. Give at least one of productUrls or searchTerms; leave empty to use productUrls only.", "items": { "type": "string" } }, "region": { "title": "Region", "enum": [ "US", "VN", "TH", "PH", "MY", "SG", "ID", "GB", "MX", "JP", "BR" ], "type": "string", "description": "TikTok Shop storefront the products belong to. It decides the language of the reviews and where the products are searched. Default `TH`. Supported: `US`, `VN`, `TH`, `PH`, `MY`, `SG`, `ID` (reviews come from Tokopedia, where TikTok Shop Indonesia sells), `GB`, `MX`, `JP` (no keyword search on these three; use productUrls). `BR` is unavailable: choosing it ends the run at once, charging only the start fee. Product URLs must belong to this storefront.", "default": "TH" }, "maxReviewsPerProduct": { "title": "Max reviews per product", "minimum": -1, "type": "integer", "description": "How many reviews to return for each product, most recent first. Default 100, minimum -1. Set 0 to return none. Set -1 for no limit, which reads every review the storefront lists for the product. Each review row is charged, so a product with thousands of reviews at -1 is a large run.", "default": 100 }, "maxProductsPerSearch": { "title": "Max products per search term", "minimum": 0, "maximum": 1000, "type": "integer", "description": "How many of the top products of each search term to pull reviews from. Default 10, minimum 0, maximum 1000. Set 0 to skip searchTerms entirely. Products are not charged; only their reviews are.", "default": 10 }, "ratings": { "title": "Star ratings", "type": "array", "description": "Only reviews with these star ratings, for example 1 and 2 for complaints or 5 for praise. With several ratings, each rating's reviews come in turn, lowest first, most recent first within a rating, sharing maxReviewsPerProduct. Leave empty for every rating.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "enumTitles": [ "1 star", "2 stars", "3 stars", "4 stars", "5 stars" ] } }, "proxyUrls": { "title": "Your own proxy URLs (optional)", "type": "array", "description": "Leave empty: the run uses the residential proxy this actor ships with, included in the price of the run. To route the run through your own provider instead, add one gateway URL per entry, for example `http://user:pass@host:port` — works with any provider that issues URLs. When set, the run uses these first and switches to the included proxy if they stop working, so a broken proxy never fails the run.", "items": { "type": "string" } } } }, "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 } } } } } } } } } }