{ "openapi": "3.0.1", "info": { "title": "Tiktok Profile Scraper", "description": "Scrape TikTok profiles and their video or repost history.", "version": "1.0", "x-build-id": "lXPFddKK7pWAYXlot" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~tiktok-profile-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-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/crawlerbros~tiktok-profile-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-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/crawlerbros~tiktok-profile-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-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": { "usernames": { "title": "TikTok Usernames", "type": "array", "description": "List of TikTok usernames to scrape (with or without @ prefix)", "items": { "type": "string" } }, "profileUrls": { "title": "Profile URLs", "type": "array", "description": "Full TikTok profile URLs (e.g. https://www.tiktok.com/@khaby.lame). Can be used instead of or together with Usernames.", "items": { "type": "string" } }, "contentTypes": { "title": "Content Types", "type": "array", "description": "What data to collect per profile. 'profile' emits the profile row. 'videos' emits post rows. 'reposts' emits repost rows.", "items": { "type": "string", "enum": [ "profile", "videos", "reposts" ], "enumTitles": [ "Profile Info", "Videos", "Reposts" ] }, "default": [ "profile", "videos" ] }, "maxPostsPerProfile": { "title": "Max Posts Per Profile", "minimum": 0, "maximum": 500, "type": "integer", "description": "Maximum number of post rows to extract per profile, combined across videos and reposts together (e.g. with contentTypes including both, up to this many total rows are emitted, not this many of each). Set to 0 to skip post extraction. Note: for videos, TikTok's own anti-bot defenses cap anonymous (no-cookie) pagination continuation at roughly 10-40 videos per profile regardless of this setting on large/high-follower accounts; reposts are not subject to this ceiling and paginate fully. Supplying a fresh 'cookies' browser export typically yields materially more videos.", "default": 30 }, "includeProfileInfo": { "title": "Include Profile Info", "type": "boolean", "description": "Whether to include detailed profile metadata (follower counts, bio, settings, etc.) in profile rows.", "default": true }, "sessionCookie": { "title": "TikTok Session ID (Optional)", "type": "string", "description": "Value of the TikTok 'sessionid' cookie. Enables the video-list API, giving the most reliable full video history retrieval. For the strongest session context (msToken/ttwid included), use the 'cookies' field with your full browser cookie export instead." }, "cookies": { "title": "TikTok Cookies (JSON array, Optional)", "type": "array", "description": "Full browser cookie export for tiktok.com as a JSON array. Export using the 'Cookie-Editor' browser extension → Export → JSON. Provides the full session context including msToken, ttwid, tt_chain_token and sessionid — needed for authenticated requests." }, "ttwid": { "title": "TikTok Device Cookie (ttwid, Optional)", "type": "string", "description": "Value of your browser's 'ttwid' cookie from tiktok.com. Enables immediate video listing without waiting for device aging (~7 days). Find it in browser DevTools → Application → Cookies → tiktok.com → ttwid. This is a non-personal device tracking cookie, not a login credential — it does not expose your account." } } }, "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 } } } } } } } } } }