{ "openapi": "3.0.1", "info": { "title": "TikTok Profile Scraper - Followers, Likes & Bio", "description": "TikTok profile scraper for a list of handles or links. Each row has followers, following, lifetime likes, video count, bio, verified flag, avatar and the secUid that survives a rename. A handle listed twice is billed once. $0.35 per 1,000 profiles.", "version": "0.1", "x-build-id": "nNa7wngvz5XYqgdCl" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dami_studio~tiktok-user-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dami_studio-tiktok-user-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/dami_studio~tiktok-user-scraper/runs": { "post": { "operationId": "runs-sync-dami_studio-tiktok-user-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/dami_studio~tiktok-user-scraper/run-sync": { "post": { "operationId": "run-sync-dami_studio-tiktok-user-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": { "profiles": { "title": "Usernames", "type": "array", "description": "TikTok usernames (with or without @) to fetch full profile data for. A numeric user id of 15 digits or more works too: it is tried as a username first, then as an id.", "items": { "type": "string" } }, "startUrls": { "title": "Profile URLs", "type": "array", "description": "Or paste TikTok profile URLs (https://www.tiktok.com/@tiktok).", "items": { "type": "string" } }, "searchQueries": { "title": "Find accounts by keyword", "type": "array", "description": "Optional. Each keyword runs TikTok's account search and returns a full profile row for every account it finds, billed as a profile like any other. The order is TikTok's. On a run where account search gives no accounts, they come from the videos matching the keyword instead, and a free row says so.", "items": { "type": "string" } }, "maxProfilesPerSearch": { "title": "Accounts per keyword", "minimum": 1, "maximum": 100, "type": "integer", "description": "How many accounts each keyword may return, at most. An account already returned by another input is not returned or billed twice.", "default": 10 }, "moreDetails": { "title": "More account details", "type": "boolean", "description": "Adds the account's country code (region), the TikTok Shop seller flag (ttSeller), the business-account flag (commerceUser) and the mutual-follow count (friendCount). One to four seconds more per profile, same price. Accounts found by account search carry the country code either way. On a run where account search gives no accounts, the code is read from the account's own videos, and filled only when they agree.", "default": false }, "videosPerProfile": { "title": "Latest videos per account", "minimum": 0, "maximum": 10, "type": "integer", "description": "Optional add-on. Up to this many of each account's newest videos, as rows right after its profile row: link, caption, counters, hashtags and tagged accounts. TikTok shows about 10 at most. 0 keeps profiles only.", "default": 0 }, "videosPostedAfter": { "title": "Latest videos posted on or after", "type": "string", "description": "Optional. Keeps only latest videos posted on or after this date, like 2026-10-01 (UTC). Needs latest videos per account." }, "videosPostedBefore": { "title": "Latest videos posted before", "type": "string", "description": "Optional. Keeps only latest videos posted before this date, like 2026-10-15 (UTC). Needs latest videos per account." }, "minVideoLikes": { "title": "Latest videos with at least this many likes", "minimum": 0, "type": "integer", "description": "Optional add-on. Keeps only latest videos with at least this many likes. Needs latest videos per account." }, "maxVideoLikes": { "title": "Latest videos with at most this many likes", "minimum": 0, "type": "integer", "description": "Optional add-on. Keeps only latest videos with at most this many likes. Needs latest videos per account." }, "excludePinnedVideos": { "title": "Leave out pinned videos", "type": "boolean", "description": "Optional. Leaves out the videos an account pinned to the top of its profile. Needs latest videos per account.", "default": false }, "hashtags": { "title": "Videos under these hashtags", "type": "array", "description": "Optional add-on. Video rows for each hashtag, with or without #.", "items": { "type": "string" } }, "videoSearchQueries": { "title": "Videos for these keywords", "type": "array", "description": "Optional add-on. Video rows TikTok returns for each keyword. This searches videos; Find accounts by keyword above searches accounts.", "items": { "type": "string" } }, "videoUrls": { "title": "Video links", "type": "array", "description": "Optional add-on. One row per video link, like https://www.tiktok.com/@handle/video/1234567890123456789.", "items": { "type": "string" } }, "videosPerInput": { "title": "Videos per hashtag or keyword", "minimum": 1, "maximum": 100, "type": "integer", "description": "How many videos each hashtag or keyword may return, at most.", "default": 10 }, "includeSubtitles": { "title": "Subtitles on video rows", "type": "boolean", "description": "Optional add-on. Adds the subtitles TikTok itself publishes for a video, as plain text, when it has any. Slower: one more read per video.", "default": false }, "commentsPerVideo": { "title": "Comments per video", "minimum": 0, "maximum": 50, "type": "integer", "description": "Optional add-on. Up to this many comments under each video row, in TikTok's own order. 0 means no comments.", "default": 0 }, "repliesPerComment": { "title": "Replies per comment", "minimum": 0, "maximum": 10, "type": "integer", "description": "Optional add-on. Up to this many replies under each comment. Needs comments per video.", "default": 0 }, "saveProfilePicture": { "title": "Save profile pictures", "type": "boolean", "description": "Optional add-on. Keeps a copy of each profile picture in this run's own storage, which expires with the run's other data, and adds its key and link to the row.", "default": false }, "notionConnector": { "title": "Notion connector ID (optional)", "type": "string", "description": "Optional. Deliver the profiles to your connected Notion via Apify MCP connectors." }, "notionParentId": { "title": "Notion data-source ID (optional)", "type": "string", "description": "Optional Notion database/data-source id to create the pages in." }, "sessionCookies": { "title": "Account cookies (not needed)", "type": "array", "description": "Optional: your own session, used only for your run. You are responsible for using it within the site's terms. Runs work without it." }, "proxyConfiguration": { "title": "Proxy (optional)", "type": "object", "description": "Not required. Your own proxy servers are used exactly as given.", "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 } } } } } } } } } }