{ "openapi": "3.0.1", "info": { "title": "Trending Videos Insights and Branded Hashtag Views & Likes", "description": "The TikTok Trending Videos Insights Scraper collects real-time trending videos with views, likes, comments, shares, creators, sounds, and hashtag analytics. Get structured JSON or CSV for trend research, content strategy, influencer insights, and market analysis.", "version": "0.1", "x-build-id": "xRLUYzIaNWa6ZIS1L" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scraper-engine~tiktok-trending-videos-insights/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scraper-engine-tiktok-trending-videos-insights", "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/scraper-engine~tiktok-trending-videos-insights/runs": { "post": { "operationId": "runs-sync-scraper-engine-tiktok-trending-videos-insights", "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/scraper-engine~tiktok-trending-videos-insights/run-sync": { "post": { "operationId": "run-sync-scraper-engine-tiktok-trending-videos-insights", "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": { "targetMarket": { "title": "🌐 Target Market (Country Code)", "type": "string", "description": "Two-letter country code for the ad market to analyze (e.g. 'US', 'AU', 'GB', 'CA'). Falls back to the legacy 'countryCode' key if set instead. Default: 'US'." }, "rankBy": { "title": "📊 Rank Ads By", "enum": [ "topPicks", "highestCtr" ], "type": "string", "description": "The Creative Center Top Ads API genuinely supports only 2 distinct orderings — everything else collapses into one of these two. 'topPicks' = TikTok's recommended/top-performing feed (order_by=for_you). 'highestCtr' = sorted by click-through rate (order_by=ctr). Falls back to the legacy 'sortOrder' key (hot/view/like/share/comment) if set instead, honestly mapped to one of these 2 real behaviors." }, "adLimit": { "title": "🎬 Ad Limit (Max Ads to Analyze)", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of ad rows to collect and analyze (1-1000), AFTER the minLikes/maxCostPerAd filters below are applied. Falls back to the legacy 'maxItems' key if set instead. Default: 100." }, "lookbackDays": { "title": "📅 Lookback Period (Days)", "minimum": 1, "maximum": 30, "type": "integer", "description": "How many days back the Top Ads window covers (1-30). Falls back to the legacy 'period' key if set instead. Default: 7." }, "minLikes": { "title": "👍 Minimum Likes", "minimum": 0, "type": "integer", "description": "Only keep ads with at least this many likes. Example: minLikes=1000 drops every ad with fewer than 1000 likes. 0 = no filter (default).", "default": 0 }, "maxCostPerAd": { "title": "💰 Maximum Cost Per Ad", "minimum": 0, "type": "number", "description": "Only keep ads whose raw 'cost' field is at or below this value — use it to focus on lower-spend ads that still perform well. Example: maxCostPerAd=200 keeps only ads with cost<=200. 0 = no cap (default).", "default": 0 }, "proxyConfiguration": { "title": "🔌 Proxy Configuration", "type": "object", "description": "Choose which proxies to use. If TikTok rejects the connection, a RESIDENTIAL proxy is used automatically as a fallback with a fresh IP per retry." } } }, "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 } } } } } } } } } }