{ "openapi": "3.0.1", "info": { "title": "TikTok Scraper - Hashtags, Profiles & Video Data", "description": "Scrape TikTok videos, profiles, hashtags, and search results. Get video URLs, play counts, likes, comments, shares, and channel signals for research and monitoring.", "version": "0.4", "x-build-id": "7qip9HVo2kARjef1w" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lentic_clockss~tiktok-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lentic_clockss-tiktok-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/lentic_clockss~tiktok-scraper/runs": { "post": { "operationId": "runs-sync-lentic_clockss-tiktok-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/lentic_clockss~tiktok-scraper/run-sync": { "post": { "operationId": "run-sync-lentic_clockss-tiktok-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": "Scrape mode", "enum": [ "hashtag", "user", "search", "video" ], "type": "string", "description": "What to scrape from TikTok", "default": "user" }, "hashtags": { "title": "Hashtags", "type": "array", "description": "Hashtags to scrape (without #). Used when mode is 'hashtag'.", "default": [], "items": { "type": "string" } }, "profiles": { "title": "User profiles", "type": "array", "description": "TikTok usernames to scrape (without @). Used when mode is 'user'. Video watch URLs pasted here are moved to videoUrls.", "default": [ "openai" ], "items": { "type": "string" } }, "keywords": { "title": "Search keywords", "type": "array", "description": "Keywords to search for. Used when mode is 'search'.", "default": [], "items": { "type": "string" } }, "videoUrls": { "title": "Video URLs", "type": "array", "description": "Direct TikTok video URLs. Used when mode is 'video'. Comment records may appear when TikTok fires comment APIs on the opened page (not a dedicated comment mode).", "default": [], "items": { "type": "string" } }, "startUrls": { "title": "Start URLs (optional)", "type": "array", "description": "Optional TikTok URLs. Profile links fill profiles (mode user), /tag/ links fill hashtags, /search?q= fills keywords, and /video/ links fill videoUrls. If mode has no matching targets, mode is inferred from these URLs.", "default": [], "items": { "type": "string" } }, "maxResults": { "title": "Max results (max 1,000; free users capped at 1,000/run)", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of items to scrape (1–1,000). Free Apify plan users are limited to 1,000 results per run and 10 total runs of this Actor — limits set by the Actor developer. Alias: resultsPerPage.", "default": 1 }, "resultsPerPage": { "title": "Results per page (alias)", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Alias for maxResults (Clockworks-style). When set, overrides maxResults for this run." }, "downloadVideos": { "title": "Download videos", "type": "boolean", "description": "Download video files and store them in Apify Key-Value Store. Each video adds a downloadUrl field. Increases cost and run time.", "default": false }, "enrichDetails": { "title": "Enrich profile and video leads", "type": "boolean", "description": "Keep profile/video identity, bio link, person/org, social/web, and truthful lead absence fields. Enabled by default.", "default": true }, "maxScrolls": { "title": "Max scroll actions", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum number of scroll actions to load more content. More scrolls = more results but slower.", "default": 15 }, "pageTimeout": { "title": "Page timeout (seconds)", "minimum": 60, "maximum": 300, "type": "integer", "description": "Maximum time to wait for page to load", "default": 120 }, "workerBaseUrl": { "title": "Worker base URL (optional)", "type": "string", "description": "Override the Cloud Run worker origin for this run. Defaults to Actor env WORKER_BASE_URL. Use when testing a staging worker; production migrations should update WORKER_BASE_URL in Actor settings (no code change).", "default": "" } } }, "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 } } } } } } } } } }