{ "openapi": "3.0.1", "info": { "title": "TikTok Profile Scraper: All Videos, Stats & MP4", "description": "Scrape all videos of TikTok profiles: plays, likes, comments, shares, saves, hashtags, sound, date. Date range, only new videos since the last run, MP4 download without watermark, and a table of profiles: exact followers, contacts (Telegram, Instagram, website, email), average plays.", "version": "0.1", "x-build-id": "fJ3mqbYh5ZcDre7vd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/s_actors~tiktok-profile-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-s_actors-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/s_actors~tiktok-profile-scraper/runs": { "post": { "operationId": "runs-sync-s_actors-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/s_actors~tiktok-profile-scraper/run-sync": { "post": { "operationId": "run-sync-s_actors-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", "required": [ "profiles" ], "properties": { "profiles": { "title": "👤 TikTok profiles", "type": "array", "description": "One per line: @username, a username, or a profile link (tiktok.com/@user). Public profiles only: private and banned accounts are reported in the run status and are free. Each account's stats and contacts (Telegram, Instagram, YouTube, website, email from the bio) go to the profiles table once, free.", "items": { "type": "string" } }, "maxVideosPerProfile": { "title": "🎬 Max videos per profile", "minimum": 0, "type": "integer", "description": "How many videos to scrape from each profile, newest first. 0 = all public videos of the profile (thousands are fine: about 25 videos a second).", "default": 100 }, "postedAfter": { "title": "📅 Posted after", "type": "string", "description": "Only videos posted after this: a date like 2025-01-01 or a period like 7 days, 2 weeks, 6 months, 1 year (ago). Reading stops at the first older video." }, "postedBefore": { "title": "📅 Posted before", "type": "string", "description": "Only videos posted before this: a date like 2025-03-01 or a period like 30 days (ago). The Actor jumps straight to this date, without paging through newer videos." }, "minPlays": { "title": "▶️ Minimum plays", "minimum": 0, "type": "integer", "description": "Only videos with at least this many plays (views). Leave empty for all." }, "skipPhotoPosts": { "title": "🖼️ Skip photo posts", "type": "boolean", "description": "Leave out photo carousels (slideshows) and keep only videos.", "default": false }, "onlyNewVideos": { "title": "🔔 Only new videos since the previous run", "type": "boolean", "description": "Output only videos newer than the newest one any earlier run in your account saw for this profile (key-value store tiktok-profile-state). The first run outputs videos as usual (within Max videos per profile) and remembers the newest. A run with no new videos costs only the start.", "default": false }, "downloadVideos": { "title": "⬇️ Download videos (MP4)", "type": "boolean", "description": "Save each video as an MP4 without the TikTok watermark (and all images of photo posts as JPG) to the run's key-value store. The row gets videoFileUrl (or imageFileUrls). Charged per downloaded video, on top of the video row. About 1 to 3 seconds per video.", "default": false }, "maxConcurrency": { "title": "⚡ Profiles at the same time", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many profiles are scraped in parallel. Each profile's videos are read page by page (15 a page). Downloads run at most 3 at a time.", "default": 5 }, "proxyConfiguration": { "title": "🛡️ Proxy", "type": "object", "description": "Requests go direct first and switch to Apify datacenter proxies (then residential) when TikTok refuses them. The default works for most runs.", "default": { "useApifyProxy": true } }, "debugLog": { "title": "🐞 Debug log", "type": "boolean", "description": "Log every retried request (for troubleshooting).", "default": 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 } } } } } } } } } }