{ "openapi": "3.0.1", "info": { "title": "TikTok Shop Product Scraper & Viral Radar", "description": "Scrape live TikTok Shop products by keyword or URL. Extract prices, sales, ratings, reviews, sellers, discounts, and images, then rank opportunities with a transparent viral score. Export verified results to JSON, CSV, Excel, or API—no external data provider required.", "version": "0.3", "x-build-id": "XCSXQ9LupweLk0lml" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nexascout~tiktok-shop-product-radar/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nexascout-tiktok-shop-product-radar", "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/nexascout~tiktok-shop-product-radar/runs": { "post": { "operationId": "runs-sync-nexascout-tiktok-shop-product-radar", "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/nexascout~tiktok-shop-product-radar/run-sync": { "post": { "operationId": "run-sync-nexascout-tiktok-shop-product-radar", "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": "TikTok Shop product URLs", "maxItems": 50, "type": "array", "description": "Optional direct TikTok Shop PDP URLs for current product data. Current tiktok.com/shop/pdp links and legacy shop.tiktok.com links are accepted. Combine with searchQueries or leave empty for keyword-only discovery.", "items": { "type": "object", "properties": { "url": { "type": "string", "title": "URL", "description": "A public TikTok Shop product URL." } }, "required": [ "url" ] }, "default": [] }, "searchQueries": { "title": "Product search keywords", "maxItems": 10, "type": "array", "description": "Optional product keywords or niches to discover, for example car accessories, skincare serum, or kitchen gadgets. Use at least one search query or product URL; the default query keeps Store and MCP test runs non-empty.", "default": [ "car accessories" ], "items": { "type": "string" } }, "region": { "title": "TikTok Shop region", "enum": [ "US" ], "type": "string", "description": "TikTok Shop market code. The MVP currently supports the United States.", "default": "US" }, "maxProductsPerQuery": { "title": "Maximum returned products per keyword", "minimum": 1, "maximum": 10, "type": "integer", "description": "Maximum billable dataset rows returned per keyword. The Actor may inspect extra candidates to fill the requested number with live verified products.", "default": 3 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "US residential proxy is the recommended default because TikTok Shop is geo-sensitive and actively rate-limits data-center traffic.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } }, "maxConcurrency": { "title": "Maximum extraction concurrency", "minimum": 1, "maximum": 2, "type": "integer", "description": "Keep this at 1–2 to reduce TikTok security challenges and residential proxy traffic.", "default": 2 }, "navigationTimeoutSecs": { "title": "Navigation timeout (seconds)", "minimum": 15, "maximum": 120, "type": "integer", "description": "Maximum time allowed for each HTTP or browser navigation.", "default": 45 }, "sortBy": { "title": "Sort results by", "enum": [ "VIRAL_SCORE", "SALES", "RATING", "PRICE_LOW_TO_HIGH" ], "type": "string", "description": "Controls the final dataset order. VIRAL_SCORE is recommended for opportunity discovery; this is snapshot ranking, not historical growth.", "default": "VIRAL_SCORE" }, "includeRawData": { "title": "Include raw source data", "type": "boolean", "description": "Include the best raw product object captured from TikTok. Useful for debugging, but makes exports larger.", "default": false }, "includeSearchFallbacks": { "title": "Include search-only leads", "type": "boolean", "description": "Return indexed product URLs even when the live TikTok page could not be validated. Disabled by default so normal datasets contain only live verified products. When enabled, search-only leads are also billable dataset results.", "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 } } }, "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 } } } } } } } } } }