{ "openapi": "3.0.1", "info": { "title": "Tiktiok Shop Product Reviews", "description": "Scrapes every review from any TikTok Shop product page: rating, text, photos, variant, reviewer name/country, verified & incentivized flags. Includes product title, price, per-SKU stock, sold count, category, rating breakdown, shop stats. Sort by newest or filter by star rating", "version": "0.0", "x-build-id": "bA7eiKqC4SDe0xI2m" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/reviewly~tiktiok-shop-product-reviews/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-reviewly-tiktiok-shop-product-reviews", "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/reviewly~tiktiok-shop-product-reviews/runs": { "post": { "operationId": "runs-sync-reviewly-tiktiok-shop-product-reviews", "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/reviewly~tiktiok-shop-product-reviews/run-sync": { "post": { "operationId": "run-sync-reviewly-tiktiok-shop-product-reviews", "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": [ "startUrls" ], "properties": { "startUrls": { "title": "Start URLs", "type": "array", "description": "TikTok Shop product pages to scrape. Both URL shapes work — https://www.tiktok.com/shop/pdp// and https://shop.tiktok.com/us/pdp// — and so does a bare product id on its own, e.g. 1731578642912612516. The slug is ignored; only the trailing id matters.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxReviews": { "title": "Max reviews per product", "minimum": 0, "type": "integer", "description": "Stop after this many reviews per product. 0 means collect every review the API will serve.", "default": 0 }, "sortBy": { "title": "Sort reviews by", "enum": [ "relevance", "newest" ], "type": "string", "description": "Relevance is what the product page shows by default. Newest first is the order to pick if you re-run this actor on a schedule and only care about what has come in since.", "default": "relevance" }, "ratingFilter": { "title": "Only this star rating", "enum": [ "all", "5", "4", "3", "2", "1" ], "type": "string", "description": "Collect only reviews with this many stars. Leave on All to collect everything. Note that the counts shown per star in ratingBreakdown are what this filter pages through.", "default": "all" }, "includePrice": { "title": "Fetch the real price", "type": "boolean", "description": "TikTok masks prices in the product page HTML it serves to non-browser clients (you get \"*\" instead of \"7.84\"). With this on, the actor makes one extra API call per product to get the real sale price, original price, discount, per-SKU prices and live stock. Prices are promotion-personalized, so expect them to move between runs.", "default": true }, "pageSize": { "title": "Reviews per request", "minimum": 1, "maximum": 1500, "type": "integer", "description": "How many reviews to ask for per API call. The API honours up to 1500; above that it returns an empty response. 500 is a good balance — most products come back in one or two calls without any single response getting huge.", "default": 500 }, "requestDelayMs": { "title": "Delay between requests (ms)", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Pause between API calls. No rate limiting was observed while building this actor — 40 back-to-back calls on one session all succeeded — so this defaults to no delay. Raise it if you are scraping a long list of products and want to tread more lightly.", "default": 0 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Recommended. The proxy country should match the product's TikTok Shop region — a US proxy for a /us/ product — because TikTok redirects a mismatched region to its homepage instead of the product page. Prices and promotions are also regional." } } }, "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 } } }, "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 } } } } } } } } } }