{ "openapi": "3.0.1", "info": { "title": "TikTok User Search Scraper", "description": "Finding the right TikTok creators by hand is slow. Search any keyword and get full profiles in bulk: username, bio, bio link, followers, likes, videos, verified, TikTok Shop and live status. Built for influencer discovery and lead gen. No login.", "version": "1.0", "x-build-id": "7w22K0fIXQCxBKeiF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawl_craft~tiktok-user-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawl_craft-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/crawl_craft~tiktok-user-search-scraper/runs": { "post": { "operationId": "runs-sync-crawl_craft-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/crawl_craft~tiktok-user-search-scraper/run-sync": { "post": { "operationId": "run-sync-crawl_craft-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", "properties": { "urls": { "title": "๐Ÿ”— TikTok search links or keywords", "type": "array", "description": "One entry per line. Paste TikTok user-search links (https://www.tiktok.com/search/user?q=cats), any TikTok search link with a q= keyword, profile links (https://www.tiktok.com/@nike searches for \"nike\") or simply type keywords. Use Bulk edit to paste a whole list at once.", "items": { "type": "string" } }, "searchQueries": { "title": "๐Ÿ” Search keywords", "type": "array", "description": "Your keyword will apply to profiles. Any query that works in TikTok's own user search works here (names, niches, brands, hashtags without #). Combined with the links above; when both lists are empty the Actor searches for \"cats\".", "items": { "type": "string" } }, "maxProfilesPerQuery": { "title": "๐Ÿ“Š Profiles per query", "minimum": 1, "type": "integer", "description": "The maximum number of profiles to extract per query. TikTok may return fewer for rare keywords. Free plan users get up to 10 profiles per run; paid Apify plans have no limit.", "default": 10 }, "enrichProfiles": { "title": "๐Ÿงฌ Full profile details", "type": "boolean", "description": "Adds exact counts (following, friends, likes given), the bio link, TikTok Shop and commerce info, privacy and duet/stitch/comment settings and story status to every profile. Turn this and the option below off for a fast run with the basic search fields only.", "default": true }, "enrichProfilePages": { "title": "๐Ÿ“… Account creation date and language", "type": "boolean", "description": "Also collects the account creation date, the profile language, live status and organization flag. This is slower; turn it off when you only need counts and bios.", "default": true }, "dedupeAcrossQueries": { "title": "๐Ÿงน Remove duplicates across queries", "type": "boolean", "description": "When several keywords return the same account, keep it only once (under the first query that returned it). Off = every query gets its full list.", "default": false }, "concurrency": { "title": "โšก Parallel requests", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many searches and profile-detail requests run at the same time.", "default": 5 }, "max_retries": { "title": "๐Ÿ” Retries per request", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many attempts a request gets before it is given up.", "default": 3 }, "request_delay": { "title": "โณ Delay between requests (seconds)", "minimum": 0, "maximum": 10, "type": "number", "description": "Optional pause before each request. 0 = as fast as possible.", "default": 0 }, "proxyConfiguration": { "title": "๐ŸŒ Proxy configuration", "type": "object", "description": "Optional. Choose the proxy settings for your run. Leave the default if you are unsure.", "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 }, "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 } } } } } } } } } }