{ "openapi": "3.0.1", "info": { "title": "TikTok Hashtag Scraper - View Counts & Top Posts", "description": "Sizes TikTok hashtags for a campaign. One row per hashtag with 16 fields: all-time posts and video views, promoted flag, the trend over time, audience split by age, interest and country, related hashtags, top videos and top creators. Choose the country and a 7, 30 or 120 day window.", "version": "0.0", "x-build-id": "G31ZVJNXckN75xzLf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parseforge~tiktok-hashtag-analytics-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parseforge-tiktok-hashtag-analytics-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/parseforge~tiktok-hashtag-analytics-scraper/runs": { "post": { "operationId": "runs-sync-parseforge-tiktok-hashtag-analytics-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/parseforge~tiktok-hashtag-analytics-scraper/run-sync": { "post": { "operationId": "run-sync-parseforge-tiktok-hashtag-analytics-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": { "mode": { "title": "Mode", "enum": [ "specificHashtags" ], "type": "string", "description": "Look up analytics for the hashtag names you provide. (The trending-hashtags mode was removed: TikTok deprecated the public endpoint it relied on.)", "default": "specificHashtags" }, "maxItems": { "title": "Maximum results", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "How many hashtag results to collect per run." }, "hashtags": { "title": "Hashtags", "minItems": 1, "type": "array", "description": "Hashtag names to look up. The # is optional, and a pasted TikTok hashtag URL (https://www.tiktok.com/tag/fyp) or a comma-separated list in one box both work — they are read as hashtag names. Two-word entries like \"black friday\" are joined the way TikTok joins them.", "items": { "type": "string" } }, "period": { "title": "Time Period (days)", "minimum": 7, "maximum": 120, "type": "integer", "description": "Time period recorded on each row: 7, 30 or 120 days. Any other number is recorded as the nearest of those three.", "default": 7 }, "countryCode": { "title": "Country Code", "enum": [ "US", "GB", "DE", "FR", "JP", "IT", "ES", "BR", "MX", "CA", "AU", "RU", "TR", "SA", "AE", "EG", "ID", "IN", "PH", "TH", "VN", "MY", "SG", "KR", "PL", "NL", "BE", "SE", "NO", "DK", "FI", "CH", "AT", "PT", "GR", "CZ", "RO", "HU", "AR", "CL", "CO", "PE", "ZA", "IL", "PK", "BD", "NG", "KE", "IE" ], "type": "string", "description": "Country recorded on each row. The public hashtag page is not country-scoped, so this labels the output; an unlisted code is carried through with a warning instead of stopping the run.", "default": "US" }, "maxConcurrency": { "title": "Max Concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Parallel hashtag lookups. Each one drives its own browser context, so the Actor caps this at 3 to stay inside its memory limit.", "default": 5 }, "enrichOutput": { "title": "✨ Enrich each hashtag with cross-platform trend data", "type": "boolean", "description": "Toggle on to add cross-platform momentum + growth rates to every hashtag (TikTok, Google, YouTube, Amazon). Default off (free of charge). Requires an enrichment connector below.", "default": false }, "enrichConnector": { "title": "✨ Enrichment Connector", "type": "string", "description": "Pick the Trends MCP (recommended) for cross-platform momentum, or DataForSEO for Google SERP rank + Amazon results on the hashtag. Click '+' to authorize a new connector if you haven't yet." }, "enrichTool": { "title": "✨ Enrichment tool override (advanced)", "type": "string", "description": "Override the auto-picked tool name. Leave empty for auto-detect." }, "mcpProxyUrlOverride": { "title": "🛠 MCP proxy URL override (dev/diagnostic)", "type": "string", "description": "Diagnostic only. Bypasses Apify's MCP proxy and talks directly to an MCP server URL. Leave empty for normal use." }, "mcpTokenOverride": { "title": "🛠 MCP bearer token override (dev/diagnostic)", "type": "string", "description": "Diagnostic only. Used with the URL override above — paste the service's API key to authenticate directly. Leave empty for normal use." } } }, "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 } } } } } } } } } }