{ "openapi": "3.0.1", "info": { "title": "TikTok Keyword Search & Discovery Scraper", "description": "Search TikTok by keyword or phrase and get matching videos with engagement stats, author profiles, music metadata, hashtags, and location tags, with optional discovery expansion for more results.", "version": "1.0", "x-build-id": "tcX6RqxxcKKu1v8kV" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/vexaloom-labs~tiktok-keyword-search-and-discovery-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-vexaloom-labs-tiktok-keyword-search-and-discovery-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/vexaloom-labs~tiktok-keyword-search-and-discovery-scraper/runs": { "post": { "operationId": "runs-sync-vexaloom-labs-tiktok-keyword-search-and-discovery-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/vexaloom-labs~tiktok-keyword-search-and-discovery-scraper/run-sync": { "post": { "operationId": "run-sync-vexaloom-labs-tiktok-keyword-search-and-discovery-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": [ "searchType" ], "properties": { "searchType": { "title": "What to Search", "enum": [ "videos", "photos", "hashtags" ], "type": "string", "description": "Videos: keyword video search. Photos: slideshow/photo search. Hashtags: hashtag metadata plus its top videos (uses the Hashtags field).", "default": "videos" }, "queries": { "title": "Search Queries", "type": "array", "description": "Keywords or phrases to search for (searchType=videos or photos). Each query is searched independently.", "items": { "type": "string" } }, "hashtags": { "title": "Hashtags", "type": "array", "description": "Hashtags to look up (searchType=hashtags). The # is optional, e.g. coffee or #coffee.", "items": { "type": "string" } }, "maxResultsPerQuery": { "title": "Max Results Per Query", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum posts to collect per query or hashtag, before filters. TikTok itself usually returns about 150-220 posts per query even when you ask for more. For hashtags, the metadata row is not counted against this limit.", "default": 30 }, "sortBy": { "title": "Sort By", "enum": [ "relevance", "mostLiked", "mostViewed", "newest" ], "type": "string", "description": "Client-side sort applied after collecting results. TikTok's web search does not support server-side sorting, so this only reorders the posts TikTok returned.", "default": "relevance" }, "publishedWithin": { "title": "Published Within", "enum": [ "all", "day", "week", "month", "3months", "6months" ], "type": "string", "description": "Client-side filter that drops posts older than the selected window, based on each post's creation time. TikTok ranks results by relevance, not date, so a narrow window can return fewer posts than requested; the actor scans up to 5x the requested count (capped at 500) to fill it.", "default": "all" }, "minDurationSeconds": { "title": "Minimum Duration (seconds)", "minimum": 0, "maximum": 7200, "type": "integer", "description": "Drop videos shorter than this. Leave blank for no minimum." }, "maxDurationSeconds": { "title": "Maximum Duration (seconds)", "minimum": 0, "maximum": 7200, "type": "integer", "description": "Drop videos longer than this. Leave blank for no maximum." }, "excludeAds": { "title": "Exclude Ads", "type": "boolean", "description": "Drop posts TikTok flags as paid advertisements.", "default": false }, "minLikeCount": { "title": "Minimum Like Count", "minimum": 0, "type": "integer", "description": "Drop posts with fewer likes than this. Leave blank for no minimum." }, "minViewCount": { "title": "Minimum View Count", "minimum": 0, "type": "integer", "description": "Drop posts with fewer plays/views than this. Leave blank for no minimum." }, "uniqueAuthors": { "title": "One Post Per Author", "type": "boolean", "description": "Keep at most one post per creator, so the results read like a creator shortlist. When a sort is selected, the top-ranked post from each creator is kept.", "default": false }, "maxPostsPerAuthor": { "title": "Max Posts Per Author", "minimum": 1, "maximum": 100, "type": "integer", "description": "Optional cap on how many posts one creator may contribute. Ignored when One Post Per Author is on." }, "enableExpansion": { "title": "Enable Discovery Expansion", "type": "boolean", "description": "After each keyword search, run extra searches derived from its own results: related searches, its top hashtags and its most-reused sound. Increases run time and the number of posts found. Videos only.", "default": false }, "expansionSources": { "title": "Expansion Sources", "type": "array", "description": "Which discovery sources to use when expansion is on. All three can be combined.", "items": { "type": "string", "enum": [ "suggestions", "hashtags", "sounds" ], "enumTitles": [ "Related searches", "Hashtags", "Sounds" ] }, "default": [ "suggestions", "hashtags", "sounds" ] }, "maxExpansionQueriesPerSeed": { "title": "Max Expansion Searches Per Query", "minimum": 0, "maximum": 10, "type": "integer", "description": "Maximum number of extra searches to run per keyword when expansion is on. Each one costs roughly as much run time as the original search.", "default": 3 }, "includeHashtagMetadata": { "title": "Include Hashtag Metadata", "type": "boolean", "description": "For hashtag searches: emit a metadata row with the hashtag's post count, view count, description and images. Also attaches metadata to hashtag-expansion posts when expansion is on.", "default": true } } }, "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 } } } } } } } } } }