{ "openapi": "3.0.1", "info": { "title": "TikTok Hashtag Scraper & Video Comments", "description": "TikTok Hashtag Scraper โ€” Scrape TikTok videos by hashtag and extract video details, creators, views, likes, shares, captions, timestamps, and comments. Analyze hashtag trends, audience engagement, viral content, and competitor activity with structured data.", "version": "0.1", "x-build-id": "asN44PZemmgEYhuSL" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapier~tiktok-hashtag-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapier-tiktok-hashtag-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/scrapier~tiktok-hashtag-scraper/runs": { "post": { "operationId": "runs-sync-scrapier-tiktok-hashtag-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/scrapier~tiktok-hashtag-scraper/run-sync": { "post": { "operationId": "run-sync-scrapier-tiktok-hashtag-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", "required": [ "startUrls" ], "properties": { "startUrls": { "title": "๐Ÿ”Ž Hashtags or keywords", "type": "array", "description": "One entry per search. Enter `travel`, `#travel` or a /tag/ URL. Usernames are treated as keyword searches - this actor does not scrape profile feeds.", "items": { "type": "string" } }, "maxData": { "title": "๐ŸŽฌ Videos per hashtag (parents only)", "minimum": 1, "maximum": 1000, "type": "integer", "description": "How many VIDEO rows to keep per hashtag. Comments and replies are additional rows and are NOT counted here. TikTok's search surface tops out at ~30-34 videos per keyword.", "default": 10 }, "sortOrder": { "title": "๐Ÿ”€ Order the videos by", "enum": [ "relevance", "date", "likes", "comments", "popularity" ], "type": "string", "description": "Applied to the videos that were returned, before the per-hashtag cap. Each option is one real metric - no invented ranking score.", "default": "relevance" }, "includeComments": { "title": "๐Ÿ’ฌ Fetch the comments of every video", "type": "boolean", "description": "Turn off for a videos-only run. When on, comments are also mirrored into a separate per-run dataset named tiktok-comments-.", "default": true }, "maxCommentsPerVideo": { "title": "๐Ÿ”ข Comments to keep per video", "minimum": 0, "maximum": 500, "type": "integer", "description": "Upper bound on top-level comments per video. Paginated 20 at a time; the cursor genuinely advances, so pages do not repeat.", "default": 20 }, "minCommentLikes": { "title": "โค๏ธ Skip comments below this many likes", "minimum": 0, "type": "integer", "description": "Keep only comments (and replies) whose like count is at least this value. 0 keeps everything.", "default": 0 }, "includeReplies": { "title": "โ†ช๏ธ Also open the reply thread of each comment", "type": "boolean", "description": "Only comments that report at least one reply are opened, so this costs nothing on quiet videos.", "default": false }, "maxRepliesPerComment": { "title": "๐Ÿงต Replies to keep per comment", "minimum": 0, "maximum": 200, "type": "integer", "description": "Upper bound on replies fetched under a single comment. Ignored while the reply toggle is off.", "default": 0 }, "proxyConfiguration": { "title": "๐ŸŒ Proxy", "type": "object", "description": "Optional. Every surface here works without a proxy; when you set one it is used by both the video search and the comment requests." } } }, "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 } } } } } } } } } }