{ "openapi": "3.0.1", "info": { "title": "TikTok Shop Scraper - Products, Sales, Reviews & Hot Sellers", "description": "Scrape TikTok Shop for product research: keyword search, full product details with SKUs and stock, public reviews, shop catalogs and hot-selling lists with prices and units sold. Markets: US, SG, MY, TH, PH, VN, plus ID, JP, MX for hot sellers. No login or cookies needed.", "version": "0.1", "x-build-id": "Dr26q0c6wCznGlXHv" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/clover_folktale~tiktok-shop-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-clover_folktale-tiktok-shop-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/clover_folktale~tiktok-shop-scraper/runs": { "post": { "operationId": "runs-sync-clover_folktale-tiktok-shop-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/clover_folktale~tiktok-shop-scraper/run-sync": { "post": { "operationId": "run-sync-clover_folktale-tiktok-shop-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": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "search", "product", "reviews", "shop", "hotSelling", "category", "keywordSuggest" ], "type": "string", "description": "What to scrape: search products by keyword, full details of products, public reviews, all products of a shop, the hot-selling list of a market, products of a category, or the search-box suggestions for keywords.", "default": "search" }, "keyword": { "title": "Keyword (mode: search)", "type": "string", "description": "Search keyword, e.g. \"lipstick\". English keywords work best.", "default": "lipstick" }, "keywords": { "title": "Keywords (keyword suggestions)", "type": "array", "description": "Keywords to get TikTok Shop search-box suggestions for, e.g. \"phone case\". Used in keywordSuggest mode; each keyword returns up to about 20 suggestions in TikTok Shop's order. maxResults is the total for all keywords, so set it to about 20 × the number of keywords.", "items": { "type": "string" } }, "category": { "title": "Category (mode: category)", "enum": [ "601450", "601152", "824328", "601739", "605248", "951432", "600001", "600024", "601352", "603014", "824584", "604206", "605196", "802184", "601755", "602284", "604579", "600154", "602118", "604968", "700437", "601303", "801928", "600942", "700645", "604453", "953224", "856720" ], "type": "string", "description": "First-level TikTok Shop category. The same category IDs work in US, SG, MY, TH, PH and VN. Each request returns a random batch of about 15 products, so a category cannot be listed to the end.", "default": "601450" }, "region": { "title": "Region", "enum": [ "US", "SG", "MY", "TH", "PH", "VN", "ID", "JP", "MX" ], "type": "string", "description": "TikTok Shop market. Search, product, reviews, shop, category and keyword suggestions support US, SG, MY, TH, PH, VN. Hot-selling supports MY, SG, TH, PH, VN, ID, JP, MX (not US). Defaults to US, or MY for hot-selling. A region in a TikTok Shop URL takes precedence." }, "products": { "title": "Products (modes: product, reviews)", "type": "array", "description": "TikTok Shop product URLs, share links or numeric product IDs, e.g. https://shop.tiktok.com/us/pdp/.../1729419587601863495 or 1729419587601863495.", "items": { "type": "string" } }, "reviewSort": { "title": "Review order (mode: reviews)", "enum": [ "default", "recommended", "recent" ], "type": "string", "description": "default keeps TikTok Shop's own order; recommended uses its recommended order; recent is newest first.", "default": "default" }, "reviewFilter": { "title": "Review filter (mode: reviews)", "enum": [ "all", "5stars", "4stars", "3stars", "2stars", "1star", "withMedia" ], "type": "string", "description": "All reviews, one star rating, or reviews with photos or videos. A product with no matching review counts as not found.", "default": "all" }, "shops": { "title": "Shops (mode: shop)", "type": "array", "description": "TikTok Shop store URLs, share links or numeric seller IDs, e.g. 7495061223870729031.", "items": { "type": "string" } }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of items to return in total for this run. You are charged per item returned. In keywordSuggest mode it is the total for all keywords.", "default": 20 } } }, "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 } } } } } } } } } }