{ "openapi": "3.0.1", "info": { "title": "TikTok User Search Scraper", "description": "Search TikTok users by keyword, niche, name or brand. Export matching accounts with usernames, profile URLs, follower counts, verification, bios and search rank. Filter by follower range and verified accounts. No login or cookies.", "version": "1.0", "x-build-id": "zHt9kkfs7l89Ukq04" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/coregent~tiktok-user-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-coregent-tiktok-user-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/coregent~tiktok-user-search-scraper/runs": { "post": { "operationId": "runs-sync-coregent-tiktok-user-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/coregent~tiktok-user-search-scraper/run-sync": { "post": { "operationId": "run-sync-coregent-tiktok-user-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", "required": [ "searchQueries" ], "properties": { "searchQueries": { "title": "Search queries", "type": "array", "description": "Keywords, niches, names or brands to search TikTok accounts for — one per line. Examples: fitness coach, skincare, Canberra realtor, Nike. Up to 100 queries per run; duplicates are removed.", "items": { "type": "string" }, "default": [ "fitness coach" ] }, "maxProfilesPerQuery": { "title": "Max profiles per query", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of matching accounts to return for each query (after filters). Common values: 20, 50, 100, 500, 1000. Fewer may be returned if TikTok has fewer results.", "default": 100 }, "followerRange": { "title": "Follower range (TikTok filter)", "enum": [ "ANY", "ZERO_TO_ONE_K", "ONE_K_TO_TEN_K", "TEN_K_TO_ONE_HUNDRED_K", "ONE_HUNDRED_K_PLUS" ], "type": "string", "description": "TikTok's own follower-count filter, applied at search time. Use 'Min/Max followers' below for exact limits.", "default": "ANY" }, "minFollowers": { "title": "Min followers", "minimum": 0, "type": "integer", "description": "Only return accounts with at least this many followers (exact). 0 = no minimum.", "default": 0 }, "maxFollowers": { "title": "Max followers", "minimum": 0, "type": "integer", "description": "Only return accounts with at most this many followers (exact). Leave empty for no maximum." }, "verifiedOnly": { "title": "Verified accounts only", "type": "boolean", "description": "Return only accounts with TikTok's verified badge.", "default": false }, "includePrivateAccounts": { "title": "Include private accounts", "type": "boolean", "description": "Untick to drop accounts known to be private.", "default": true }, "includeProfileDetails": { "title": "Include full profile details", "type": "boolean", "description": "Look up each account's full public profile to add the bio link and bio text, and fill in any following, likes, video or private values that search didn't return. One extra lookup per account, billed as a separate 'profile-details' event — only for accounts that were enriched.", "default": false }, "providerRoute": { "title": "Search route", "enum": [ "AUTO", "WEB", "APP_V3" ], "type": "string", "description": "Auto uses TikTok's app search, which pages deepest and supports the native follower and verified filters. Web search is currently failing at the provider and is kept for troubleshooting only.", "default": "AUTO" }, "debug": { "title": "Debug logging", "type": "boolean", "description": "Log extra detail about each search page.", "default": 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 }, "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 } } } } } } } } } }