{ "openapi": "3.0.1", "info": { "title": "Tiktok Trending Hashtags Analytics", "description": "Scrape trending TikTok hashtags with detailed analytics, including views, growth, related tags, and top content insights. This actor delivers structured data for trend tracking, marketing research, and performance analysis in JSON or CSV formats.", "version": "0.1", "x-build-id": "ocoeNzRd2Qp3rwn4G" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scraper-engine~tiktok-trending-hashtags-analytics/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scraper-engine-tiktok-trending-hashtags-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/scraper-engine~tiktok-trending-hashtags-analytics/runs": { "post": { "operationId": "runs-sync-scraper-engine-tiktok-trending-hashtags-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/scraper-engine~tiktok-trending-hashtags-analytics/run-sync": { "post": { "operationId": "run-sync-scraper-engine-tiktok-trending-hashtags-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": { "result_type": { "title": "πŸŽ›οΈ Result type", "enum": [ "top100", "top100_with_analytics", "analytics" ], "type": "string", "description": "🧠 The brain of your run! πŸƒβ€β™‚οΈ top100 = speed demon (ranking only). 🎯 top100_with_analytics = leaderboard + juicy charts for every tag. πŸ§ͺ analytics = feed your own hashtag names (see hashtag_list) and we fetch their analytics.", "default": "top100_with_analytics" }, "country": { "title": "🌍 Country / region", "enum": [ "ALL", "AL", "AR", "AT", "AU", "BD", "BE", "BG", "BH", "BR", "BY", "CA", "CH", "CL", "CN", "CO", "CZ", "DE", "DK", "EE", "EG", "ES", "FI", "FR", "GB", "GR", "HK", "HR", "HU", "ID", "IE", "IL", "IN", "IQ", "IS", "IT", "JO", "JP", "KH", "KR", "KW", "KZ", "LB", "LT", "LU", "LV", "MA", "MN", "MO", "MX", "MY", "NG", "NL", "NO", "NZ", "OM", "PE", "PH", "PK", "PL", "PT", "QA", "RO", "SA", "SE", "SG", "SK", "TH", "TR", "TW", "UA", "AE", "US", "UZ", "VN", "ZA" ], "type": "string", "description": "πŸŽͺ Trending stage: one country code or 🌐 ALL for global heat. πŸ”— Feeds both ranking + analytics calls β€” choose wisely!", "default": "US" }, "top100_period": { "title": "πŸ† Top 100 ranking period", "enum": [ "7", "30", "120" ], "type": "string", "description": "πŸ•’ How many days of hype for the Top 100 board? βœ… Only 7, 30, or 120 β€” TikTok’s rules, not ours πŸ˜‰", "default": "7" }, "analytics_period": { "title": "πŸ“Š Hashtag analytics period", "enum": [ "7", "30", "120", "365", "1095" ], "type": "string", "description": "πŸ“ˆ Trend depth for detail/analytics API β€” powers 🎯 top100_with_analytics & πŸ§ͺ analytics. πŸ“‰ More days = richer history points on the curve!", "default": "30" }, "top100_industry": { "title": "🏷️ Top 100 industry filter", "enum": [ "", "Apparel & Accessories", "Baby, Kids & Maternity", "Beauty & Personal Care", "Business Services", "Education", "Financial Services", "Food & Beverage", "Games", "Healthcare", "Home Improvement", "Household Products", "Life Services", "News & Entertainment", "Pets", "Real Estate", "Software & Apps", "Sports & Outdoor", "Tech & Electronics", "Travel", "Vehicle & Transportation" ], "type": "string", "description": "🧩 Optional slice of the leaderboard β€” fuzzy-matched to TikTok’s industry buckets. πŸšͺ Leave as β€œall” for the full firehose.", "default": "" }, "top100_new_on_board": { "title": "✨ New to Top 100 only", "type": "boolean", "description": "πŸ†• When ON (Top 100 modes only) β†’ only hashtags freshly climbing the chart for your picked window 🎒. OFF = everyone on the board.", "default": false }, "hashtag_list": { "title": "πŸ“ Custom hashtag list", "type": "array", "description": "🎯 Names without # β€” we resolve against the live trending list for your 🌍 + window. ❓ Not on the list right now? ⏭️ Skipped (TikTok limitation, not ours!).", "default": [], "items": { "type": "string" } }, "total_hashtags": { "title": "πŸ”’ Max hashtags to fetch", "minimum": 1, "maximum": 500, "type": "integer", "description": "🎚️ Cap 1–500 for Top 100 modes. πŸ§ͺ Pure analytics mode with hashtag_list? 🀷 This cap steps aside β€” your list rules.", "default": 10 }, "proxyConfiguration": { "title": "πŸ›‘οΈβš™οΈ Proxy configuration", "type": "object", "description": "πŸŽ›οΈ Toggle 🟒 Apify Proxy ON, 🌍 pick groups (Datacenter ⚑ vs cozy Residential 🏠), or πŸ”— paste your own elite proxy URLs. πŸ’‘ Hot tip: Residential 🏑🎯 = TikTok’s best friend. 🀝", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }