{ "openapi": "3.0.1", "info": { "title": "Tiktok Shop Analytics", "description": "Scrape TikTok Shop products, sellers, and creator affiliates. Calculate trending scores based on sales, ratings, and reviews. Get pricing and engagement metrics. For drop shipping research, influencer discovery, and e-commerce intelligence.", "version": "1.0", "x-build-id": "EY9zwdPsZlPwcaP2X" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/constant_quadruped~tiktok-shop-analytics/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-constant_quadruped-tiktok-shop-analytics", "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/constant_quadruped~tiktok-shop-analytics/runs": { "post": { "operationId": "runs-sync-constant_quadruped-tiktok-shop-analytics", "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/constant_quadruped~tiktok-shop-analytics/run-sync": { "post": { "operationId": "run-sync-constant_quadruped-tiktok-shop-analytics", "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": { "dataTypes": { "title": "Data Types to Collect", "type": "array", "description": "Select which types of data to scrape: products (product listings), sellers (store profiles), affiliates (creators promoting products)", "items": { "type": "string", "enum": [ "products", "sellers", "affiliates" ] }, "default": [ "products" ] }, "searchQuery": { "title": "Product Search Query", "type": "string", "description": "Search TikTok for products (e.g., 'viral skincare', 'kitchen gadgets'). Results include videos mentioning products with shop indicators." }, "categoryUrl": { "title": "Category URL", "type": "string", "description": "Direct URL to a TikTok Shop category page" }, "productUrls": { "title": "Product URLs", "type": "array", "description": "Specific TikTok Shop product URLs to scrape (e.g., https://www.tiktok.com/shop/product/...)", "items": { "type": "string" } }, "sellerUrls": { "title": "Seller/Store URLs", "type": "array", "description": "TikTok Shop seller or store profile URLs", "items": { "type": "string" } }, "sellerName": { "title": "Seller Name", "type": "string", "description": "Search for a seller by name" }, "includeSellerProducts": { "title": "Include Seller Products", "type": "boolean", "description": "Also scrape products from seller's shop", "default": true }, "hashtag": { "title": "Hashtag", "type": "string", "description": "Find creators using this hashtag (e.g., TikTokMadeMeBuyIt, AmazonFinds). The # symbol is optional." }, "creatorUrls": { "title": "Creator Profile URLs", "type": "array", "description": "Specific TikTok creator profile URLs to analyze (e.g., https://www.tiktok.com/@username)", "items": { "type": "string" } }, "region": { "title": "Region", "enum": [ "US", "UK", "ID", "TH", "VN", "MY", "PH", "SG" ], "type": "string", "description": "TikTok Shop region (affects search results and availability)", "default": "US" }, "maxProducts": { "title": "Max Products", "minimum": 1, "maximum": 200, "type": "integer", "description": "Maximum number of products/product mentions to collect", "default": 50 }, "maxCreators": { "title": "Max Creators", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum number of creators to analyze", "default": 20 }, "maxProductsPerSeller": { "title": "Max Products Per Seller", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum products to collect from each seller's shop", "default": 20 }, "enableTrendingAnalysis": { "title": "Enable Trending Analysis", "type": "boolean", "description": "Calculate trending scores and identify viral products based on engagement metrics", "default": true }, "enableCreatorAnalysis": { "title": "Enable Creator Analysis", "type": "boolean", "description": "Calculate affiliate scores and tier classifications (mega/macro/micro/nano) for creators", "default": true }, "useShopApi": { "title": "Enhanced Scraping", "type": "boolean", "description": "Use enhanced scraping with stealth mode for better results. Recommended.", "default": true }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings. TikTok has strong anti-bot measures - residential proxies are strongly recommended for best results." } } }, "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 } } } } } } } } } }