{ "openapi": "3.0.1", "info": { "title": "TikTok Search Scraper - Keyword & Hashtag Video Profile Data", "description": "Scrape TikTok videos by keyword or hashtag with full engagement — plays, likes, comments, shares, music & author details. Fast, no login required. Export to JSON, CSV & Excel or stream via webhook & API. Perfect for content research, trend tracking, influencer & competitor analysis.", "version": "0.0", "x-build-id": "Dpw3i4IIO0wVBzKt3" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/b2b_leads~TikTok-Search-Scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-b2b_leads-TikTok-Search-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/b2b_leads~TikTok-Search-Scraper/runs": { "post": { "operationId": "runs-sync-b2b_leads-TikTok-Search-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/b2b_leads~TikTok-Search-Scraper/run-sync": { "post": { "operationId": "run-sync-b2b_leads-TikTok-Search-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": { "enableKeywordSearch": { "title": "Search by keyword", "type": "boolean", "description": "Find videos by topic/keyword. On by default with sample keywords so you can click Start immediately.", "default": true }, "videoKeywords": { "title": "Keywords", "type": "array", "description": "Topics to search (e.g. cooking, gym tips, skincare).", "default": [ "cooking", "gym tips" ], "items": { "type": "string" } }, "videoMaxResults": { "title": "Videos per keyword", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum videos to collect per keyword (1–100).", "default": 20 }, "videoKeywordFetchEngagement": { "title": "Full engagement details", "type": "boolean", "description": "On by default. Adds plays, likes, comments, shares, music, duration, and cover to each video row.", "default": true }, "videoKeywordFetchAccountDetails": { "title": "Author account details", "type": "boolean", "description": "Optional. Adds author followers, bio, and verified status on each video row.", "default": false }, "videoKeywordMinPlays": { "title": "Min play count", "minimum": 0, "type": "integer", "description": "Keep only videos at or above this play count (0 = no filter).", "default": 0 }, "videoKeywordPublishedWithin": { "title": "Published within", "enum": [ "any", "7d", "30d", "90d" ], "type": "string", "description": "Only keep videos published in this time window.", "default": "any" }, "tryClassicSearchApi": { "title": "Extended search coverage", "type": "boolean", "description": "Optional. Widens keyword search to surface additional matching videos. Leave off for the fastest runs.", "default": false }, "enableHashtagSearch": { "title": "Search by hashtag", "type": "boolean", "description": "Look up specific hashtags and optionally collect the videos under them.", "default": false }, "hashtags": { "title": "Hashtags", "type": "array", "description": "Hashtag names without # (e.g. cooking, gymtok).", "default": [ "cooking", "fyp" ], "items": { "type": "string" } }, "hashtagFetchVideos": { "title": "Fetch videos for hashtags", "type": "boolean", "description": "Also collect videos under each hashtag. Off = hashtag info only.", "default": true }, "hashtagMaxVideos": { "title": "Videos per hashtag", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum videos per hashtag when video fetch is on (1–50).", "default": 20 }, "hashtagFetchEngagement": { "title": "Full engagement details", "type": "boolean", "description": "On by default. Adds plays, likes, comments, shares, music, duration, and cover to each hashtag video.", "default": true }, "hashtagFetchAccountDetails": { "title": "Author account details", "type": "boolean", "description": "Optional. Adds author followers, bio, and verified status on each hashtag video.", "default": false }, "region": { "title": "Region / market", "type": "string", "description": "Market for search results (affects language and trending).", "default": "US" }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "Optional. Every record is always saved to the run's dataset as it is collected — this webhook is an additional real-time push (CRM, Slack, Zapier, Make, custom API).", "default": "" }, "webhookFormat": { "title": "Webhook format", "enum": [ "json", "slack" ], "type": "string", "description": "json = full record object; slack = short Slack-friendly message.", "default": "json" }, "includeRaw": { "title": "Include raw data", "type": "boolean", "description": "Attach extended source fragments on each record. Larger output — for advanced users only.", "default": false }, "maxItems": { "title": "Max items (soft cap)", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Soft safety ceiling on total dataset rows (1–1,000,000). Feature limits above control real volume.", "default": 1000000 } } }, "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 } } } } } } } } } }