{ "openapi": "3.0.1", "info": { "title": "TikTok Shop Product Data Scraper - Sales, Prices & Reviews", "description": "[Limited Launch Offer $2/1K] TikTok Shop sales data from product or category URLs: units sold, prices, discounts, variants & stock, reviews, star ratings, seller info. No login.", "version": "0.1", "x-build-id": "MlYY9XOXQwyEEazCp" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kalilfagundes.w~tiktok-shop-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kalilfagundes.w-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/kalilfagundes.w~tiktok-shop-scraper/runs": { "post": { "operationId": "runs-sync-kalilfagundes.w-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/kalilfagundes.w~tiktok-shop-scraper/run-sync": { "post": { "operationId": "run-sync-kalilfagundes.w-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", "properties": { "productUrls": { "title": "Product URLs or IDs (productUrls)", "type": "array", "description": "TikTok Shop product links (shop.tiktok.com/us/pdp/..., tiktok.com/shop/pdp/..., shop.tiktok.com/view/product/...) or bare product IDs.", "items": { "type": "string" } }, "categoryUrls": { "title": "Category URLs (categoryUrls)", "type": "array", "description": "TikTok Shop category pages, e.g. https://shop.tiktok.com/us/c/beauty-personal-care/601450 - returns the category's top products (about 15 per category page).", "items": { "type": "string" } }, "includeSubcategories": { "title": "Also scrape sub-categories (includeSubcategories)", "type": "boolean", "description": "Visits the sub-categories of each category URL too, for many more top products.", "default": false }, "maxSubcategories": { "title": "Sub-categories per category (maxSubcategories)", "minimum": 0, "type": "integer", "description": "How many sub-categories to visit per category URL.", "default": 10 }, "fetchProductDetails": { "title": "Full details for category products (fetchProductDetails)", "type": "boolean", "description": "Off: category products come as product cards (price, sold, rating, shop). On: every category product is opened for the full product row (variants, stock, shop stats, seller info, reviews) - charged as a product.", "default": false }, "includeReviews": { "title": "First reviews (includeReviews)", "type": "boolean", "description": "Adds the first reviews shown on the product page (text, rating, date, variant, photos) plus the 1-5 star breakdown. No extra cost.", "default": true }, "region": { "title": "Market for bare IDs (region)", "enum": [ "us", "gb", "de", "fr", "es", "it", "ie", "mx" ], "type": "string", "description": "Used for product IDs without a URL. URLs carry their own market.", "default": "us" }, "maxItems": { "title": "Maximum rows (maxItems)", "minimum": 0, "type": "integer", "description": "Stop after this many rows. 0 = no limit.", "default": 200 }, "proxyConfiguration": { "title": "Proxy (proxyConfiguration)", "type": "object", "description": "TikTok Shop only shows a product to IPs in its market. US products are read directly; the residential proxy of the product's country is used for other markets and on retries.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }