{ "openapi": "3.0.1", "info": { "title": "Creator Profile & Video Data — TikTok", "description": "Bulk TikTok creator data by username or URL: followers, bio, verification, total likes and region, plus each creator's videos with views, likes, comments, shares, saves, hashtags, sound and play/download URLs. Comments optional.", "version": "0.1", "x-build-id": "g5qtzIzlXDxkQ4qqj" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jungle_synthesizer~tiktok-profile-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jungle_synthesizer-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/jungle_synthesizer~tiktok-profile-scraper/runs": { "post": { "operationId": "runs-sync-jungle_synthesizer-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/jungle_synthesizer~tiktok-profile-scraper/run-sync": { "post": { "operationId": "run-sync-jungle_synthesizer-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": { "sp_intended_usage": { "title": "What is the intended usage of this data?", "minLength": 1, "type": "string", "description": "What will this data feed? E.g. lead lists, KYB checks, price tracking." }, "sp_improvement_suggestions": { "title": "How can we improve this crawler for you?", "minLength": 1, "type": "string", "description": "Provide any feedback or suggestions for improvements." }, "sp_contact": { "title": "Contact email (optional)", "minLength": 1, "type": "string", "description": "We'll personally help with your use case. No spam." }, "profiles": { "title": "TikTok Profiles", "type": "array", "description": "List of TikTok usernames (e.g. @charlidamelio or charlidamelio) or full profile URLs (e.g. https://www.tiktok.com/@charlidamelio) to scrape.", "items": { "type": "string" } }, "items": { "title": "Single posts (video / photo)", "type": "array", "description": "Optional. Individual TikTok posts to scrape on their own, by URL (https://www.tiktok.com/@user/video/123 or /photo/123) or by bare post id. Each one returns its own flat row — the video's stats and play/download URLs, or, for a photo-mode post, the `image_urls` of every image. Use this alongside or instead of `profiles`.", "items": { "type": "string" } }, "maxItems": { "title": "Max Items", "type": "integer", "description": "Maximum number of profiles to return (0 = unlimited)", "default": 0 }, "includeVideos": { "title": "Include videos", "type": "boolean", "description": "Also collect the creator's videos (newest first) with view, like, comment, share and save counts, hashtags, sound, cover, play and download URLs. Nested under each profile row as a JSON array in `videos`.", "default": true }, "maxVideosPerProfile": { "title": "Max videos per profile", "type": "integer", "description": "How many of the creator's newest videos to collect per profile (0 = the full history). Values above 30 — and 0 — need `deepVideoHistory` on; without it the run clamps to 30. Each ~23 videos is one extra page load.", "default": 30 }, "deepVideoHistory": { "title": "Deep video history (extra charge)", "type": "boolean", "description": "Collect more than the 30 newest videos per creator (including the full history with `maxVideosPerProfile: 0`). Billed for what the extra crawling costs: one extra record charge per 20 videos beyond the first 30. Off by default, and with it off a deeper `maxVideosPerProfile` clamps to 30.", "default": false }, "includeComments": { "title": "Include comments", "type": "boolean", "description": "BEST-EFFORT (beta). Also open each collected video and capture its top comments (text, likes, replies, commenter). TikTok only serves the comment list to browser sessions it trusts, so many videos come back with an empty `comments` array. Costs one page load per video — keep `maxVideosWithComments` small.", "default": false }, "maxVideosWithComments": { "title": "Max videos with comments", "type": "integer", "description": "When `includeComments` is on, only the first N videos (newest first) get their comments collected.", "default": 5 }, "maxCommentsPerVideo": { "title": "Max comments per video", "type": "integer", "description": "Cap on comments captured per video when `includeComments` is on.", "default": 20 } } }, "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 } } } } } } } } } }