{ "openapi": "3.0.1", "info": { "title": "TikTok Profile Scraper | Followers, Following & Bio Emails", "description": "Scrape TikTok profiles with follower, following, heart and video counts, bio text, bio links and extracted emails. Pull full follower and following lists, and track follower growth between runs.", "version": "0.1", "x-build-id": "LYrOXddsJy6iRZLBi" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/corvuslab~tiktok-profile-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-corvuslab-tiktok-profile-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/corvuslab~tiktok-profile-scraper/runs": { "post": { "operationId": "runs-sync-corvuslab-tiktok-profile-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/corvuslab~tiktok-profile-scraper/run-sync": { "post": { "operationId": "run-sync-corvuslab-tiktok-profile-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": { "profileUrls": { "title": "๐Ÿ‘ค Profile URLs or usernames", "type": "array", "description": "TikTok profiles to scrape. Full URLs (https://www.tiktok.com/@tiktok) or bare handles (tiktok, @khaby.lame) both work.", "items": { "type": "string" } }, "startUrls": { "title": "๐Ÿ”— Start URLs", "type": "array", "description": "Any mix of TikTok URLs. Profile URLs are scraped; anything else is skipped with a warning.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "includeFollowers": { "title": "๐Ÿ‘ฅ Scrape followers", "type": "boolean", "description": "Also collect the accounts that follow each profile, as one record per follower with their own stats and bio.", "default": false }, "followersPerProfile": { "title": "๐Ÿ”ข Followers per profile", "minimum": 1, "maximum": 5000, "type": "integer", "description": "How many followers to collect per profile. TikTok serves these 30 at a time, newest follower first, and throttles a deep walk โ€” the run rides that out and keeps going. If it is ever cut short anyway, the log says so and you get what was collected.", "default": 30 }, "includeFollowing": { "title": "โžก๏ธ Scrape following", "type": "boolean", "description": "Also collect the accounts each profile follows โ€” the shorter, higher-signal list for mapping who a creator pays attention to.", "default": false }, "followingPerProfile": { "title": "๐Ÿ”ข Following per profile", "minimum": 1, "maximum": 5000, "type": "integer", "description": "How many followed accounts to collect per profile. Same 30-at-a-time paging and the same behaviour at depth as followers.", "default": 30 }, "minFollowers": { "title": "๐Ÿ“ˆ Minimum followers", "minimum": 0, "type": "integer", "description": "Drop follower/following records below this follower count. Leave empty for no minimum." }, "maxFollowers": { "title": "๐Ÿ“‰ Maximum followers", "minimum": 0, "type": "integer", "description": "Drop follower/following records above this follower count โ€” the way to filter for micro-influencers. Leave empty for no maximum." }, "verifiedOnly": { "title": "โœ… Verified accounts only", "type": "boolean", "description": "Keep only blue-check accounts in the follower/following lists.", "default": false }, "requireContact": { "title": "๐Ÿ“ง Require contact details", "enum": [ "off", "email", "phone", "either", "both" ], "type": "string", "description": "Keep only follower/following records whose bio contains contact details. Emails and links are extracted from every bio either way.", "default": "off" }, "maxResults": { "title": "๐Ÿ”ข Max results", "minimum": 0, "type": "integer", "description": "Maximum number of records to return in total, profiles and followers combined. Set 0 for unlimited.", "default": 100 }, "incrementalMode": { "title": "โ™ป๏ธ Incremental mode", "type": "boolean", "description": "Track state between runs and emit only profiles whose follower, heart or video counts changed since last time, each tagged with a changeType. New and unfollowed accounts show up as NEW and EXPIRED.", "default": false }, "stateKey": { "title": "๐Ÿ—๏ธ State key", "type": "string", "description": "Stable name for the tracked set of profiles. Leave empty to derive one automatically from your input URLs." }, "emitUnchanged": { "title": "๐Ÿ” Include unchanged records", "type": "boolean", "description": "Also emit records that have not changed since the previous run.", "default": false }, "emitExpired": { "title": "๐Ÿ‘‹ Report accounts that disappeared", "type": "boolean", "description": "Emit an EXPIRED record for anything present last run but missing now โ€” an unfollow when you are tracking a follower list, a deleted or renamed account when you are tracking profiles.", "default": false }, "telegramToken": { "title": "๐Ÿ’ฌ Telegram bot token", "type": "string", "description": "Bot token from @BotFather." }, "telegramChatId": { "title": "๐Ÿ†” Telegram chat ID", "type": "string", "description": "Chat or channel ID, e.g. \"-100123456789\" or \"@yourchannel\"." }, "slackWebhookUrl": { "title": "๐Ÿ’ผ Slack webhook URL", "type": "string", "description": "Slack incoming-webhook URL." }, "discordWebhookUrl": { "title": "๐ŸŽฎ Discord webhook URL", "type": "string", "description": "Discord incoming-webhook URL." }, "webhookUrl": { "title": "๐Ÿช Webhook URL", "type": "string", "description": "Any HTTPS endpoint. Receives a JSON POST with the matched records โ€” works with n8n, Make, and Zapier." }, "webhookHeaders": { "title": "๐Ÿงพ Webhook headers", "type": "object", "description": "Extra headers for the webhook request, e.g. {\"Authorization\": \"Bearer xyz\"}." }, "notificationLimit": { "title": "๐Ÿ”ข Records per notification", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many records to include in each notification message.", "default": 5 }, "compact": { "title": "๐Ÿ“ฆ Compact records", "type": "boolean", "description": "Emit only the core fields (id, uniqueId, nickname, url, followerCount, dataType, changeType). Ideal for AI agents and MCP clients.", "default": false }, "excludeEmptyFields": { "title": "๐Ÿงน Drop empty fields", "type": "boolean", "description": "Remove null, empty-string, and empty-array fields from each record.", "default": false }, "customMapFunction": { "title": "๐Ÿงฎ Custom map function", "type": "string", "description": "JavaScript function applied to every record before it is saved, e.g. (object) => { return {...object} }. Use it to reshape or trim output, not to filter." }, "maxRequestRetries": { "title": "๐Ÿ”„ Max request retries", "minimum": 0, "maximum": 10, "type": "integer", "description": "How many times to retry a failed request before giving up on it.", "default": 3 }, "proxyConfiguration": { "title": "๐ŸŒ Proxy configuration", "type": "object", "description": "Not needed. Both surfaces this actor uses answer from Apify's own IPs, so leave this off unless you have a reason to route the run through a specific country.", "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 } } }, "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 } } } } } } } } } }