{ "openapi": "3.0.1", "info": { "title": "TikTok Profile Scraper - Followers, Bio & Videos", "description": "Scrape TikTok profiles by username, @handle, or URL. Extract followers, likes, bio, avatars, verification, secUid, account flags, and recent videos with views, likes, comments, shares, covers, music, hashtags, and links.", "version": "0.0", "x-build-id": "3QBjWRQV3KDAAGceG" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/elliotpadfield~tiktok-profile-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-elliotpadfield-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/elliotpadfield~tiktok-profile-scraper/runs": { "post": { "operationId": "runs-sync-elliotpadfield-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/elliotpadfield~tiktok-profile-scraper/run-sync": { "post": { "operationId": "run-sync-elliotpadfield-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": { "profiles": { "title": "Profiles", "uniqueItems": true, "type": "array", "description": "TikTok usernames, @handles, or profile URLs.", "items": { "type": "string" }, "default": [ "apify" ] }, "usernames": { "title": "Usernames", "uniqueItems": true, "type": "array", "description": "Alias for Profiles.", "items": { "type": "string" } }, "profileUrls": { "title": "Profile URLs", "uniqueItems": true, "type": "array", "description": "Alias for Profiles.", "items": { "type": "string" } }, "maxProfiles": { "title": "Maximum Profiles", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of unique profiles to process.", "default": 100 }, "includeVideos": { "title": "Include Recent Videos", "type": "boolean", "description": "Fetch recent public videos through TikTok's browser-backed web API session.", "default": true }, "maxVideosPerProfile": { "title": "Maximum Videos per Profile", "minimum": 0, "maximum": 500, "type": "integer", "description": "Maximum recent public videos to fetch per profile.", "default": 30 }, "maxVideoPagesPerProfile": { "title": "Maximum Video Pages per Profile", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum TikTok video-list pages to fetch per profile. Each page normally returns up to 30 videos.", "default": 1 }, "minFollowers": { "title": "Minimum Followers", "minimum": 0, "type": "integer", "description": "Only save profiles with at least this many followers." }, "maxFollowers": { "title": "Maximum Followers", "minimum": 0, "type": "integer", "description": "Only save profiles with no more than this many followers." }, "verifiedOnly": { "title": "Verified Only", "type": "boolean", "description": "Only save verified TikTok profiles.", "default": false }, "includePrivateAccounts": { "title": "Include Private Accounts", "type": "boolean", "description": "Save private accounts when TikTok exposes their public profile metadata.", "default": false }, "maxConcurrency": { "title": "Maximum Concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Number of profiles to fetch in parallel.", "default": 5 }, "requestDelayMs": { "title": "Request Delay", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Delay between retry attempts in milliseconds.", "default": 500 }, "maxRetries": { "title": "Maximum Retries", "minimum": 0, "maximum": 8, "type": "integer", "description": "Retry count for transient HTTP failures, proxy failures, and target-side 429/5xx responses.", "default": 3 } } }, "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 } } } } } } } } } }