{ "openapi": "3.0.1", "info": { "title": "TikTok Hashtag Scraper With Sticker Text & Language", "description": "TikTok Hashtag Scraper extracts public videos from hashtags, including captions, sticker text, creators, views, likes, comments, shares, hashtags, and video URLs. Filter results by language and sticker text for trend research, content analysis, and audience insights.", "version": "0.1", "x-build-id": "uSCyfJotlTfNvOiqc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/api-empire~tiktok-hashtag-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-api-empire-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/api-empire~tiktok-hashtag-scraper/runs": { "post": { "operationId": "runs-sync-api-empire-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/api-empire~tiktok-hashtag-scraper/run-sync": { "post": { "operationId": "run-sync-api-empire-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": "Hashtags or keywords to scan, one per line. '#' is optional. A https://www.tiktok.com/tag/ URL is accepted and the tag name is taken from it.", "default": [ "travel" ], "items": { "type": "string" } }, "maxData": { "title": "🔢 Videos kept per hashtag", "minimum": 1, "maximum": 1000, "type": "integer", "description": "How many rows to keep per hashtag AFTER the filters below are applied. The live surface ceiling is 30-34 videos per hashtag, so anything above that simply returns what exists.", "default": 10 }, "onlyVideosWithOnScreenText": { "title": "✍️ Keep only videos that carry editor text", "type": "boolean", "description": "When on, a video is kept only if it has at least one on-screen text block. In a 123-video sample this cut the set to 37 rows.", "default": false }, "captionLanguage": { "title": "🌐 Caption language codes to keep", "type": "array", "description": "Language codes to keep, e.g. en, de, tl, tr, un. Leave empty to keep every language. Matching is case-insensitive.", "default": [], "items": { "type": "string" } }, "sortOrder": { "title": "🔃 Order rows within each hashtag", "enum": [ "relevance", "date", "popularity" ], "type": "string", "description": "Local re-ordering of the rows returned for each hashtag. 'relevance' keeps TikTok's own search order untouched. The other two sort the rows this run collected - they do not ask TikTok for a different feed.", "default": "relevance" }, "proxyConfiguration": { "title": "🛡️ Proxy route", "type": "object", "description": "Optional. All three TikTok surfaces used here were measured working with no proxy at all, so the run starts with a direct connection and only escalates (datacenter, then residential) if TikTok refuses the session.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }