{ "openapi": "3.0.1", "info": { "title": "TikTok Video Scraper - Bulk Data by URL", "description": "TikTok Video Scraper that extracts video records from a list of TikTok video URLs or IDs. Returns description, post date, duration, plays, likes, comments, shares, saves, hashtags, sound details, creator profile and cover image URLs. No login, no API key. Deleted videos are reported, never charged.", "version": "0.1", "x-build-id": "NgJwVhdIlNEzEc6zv" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/praise-most-high~tiktok-bulk-video-data/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-praise-most-high-tiktok-bulk-video-data", "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/praise-most-high~tiktok-bulk-video-data/runs": { "post": { "operationId": "runs-sync-praise-most-high-tiktok-bulk-video-data", "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/praise-most-high~tiktok-bulk-video-data/run-sync": { "post": { "operationId": "run-sync-praise-most-high-tiktok-bulk-video-data", "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": [ "videoUrls" ], "properties": { "videoUrls": { "title": "TikTok video URLs or IDs", "type": "array", "description": "The videos to extract, one per line. Accepts full tiktok.com/@user/video/ and /photo/ links, and bare numeric video IDs — you can mix both. Duplicates are removed before anything is fetched, so a list pasted twice is never charged twice. Short vm.tiktok.com links must be expanded first.", "items": { "type": "string" } }, "maxVideos": { "title": "Maximum videos per run", "minimum": 1, "maximum": 50000, "type": "integer", "description": "A hard ceiling on how many videos this run will fetch, applied after duplicates are removed. Use it to bound the cost of a large paste. Set it to the number of videos you are willing to pay for.", "default": 1000 }, "includeStats": { "title": "Include engagement metrics", "type": "boolean", "description": "Add plays, likes, comments, shares, saves and reposts to each record, read from TikTok's own counters at the moment of the run.", "default": true }, "includeAuthor": { "title": "Include creator profile", "type": "boolean", "description": "Add the creator block: username, display name, profile URL, avatar image URL, bio, verified and private-account flags, follower count and video count.", "default": true }, "includeMusic": { "title": "Include sound details", "type": "boolean", "description": "Add the sound attached to the video: its ID, title, the account that owns it, duration, album, and whether it is an original sound rather than a licensed track.", "default": true }, "includeUnavailable": { "title": "Report unavailable videos", "type": "boolean", "description": "Emit a row for every requested video that could not be read, carrying available=false and the reason — deleted, private, region-blocked or removed. These rows are never charged. Turn this off to receive only successful extractions.", "default": true }, "requestDelayMs": { "title": "Delay between requests (ms)", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Milliseconds to wait between videos. The default of 400 ms paces a run politely against the source. Raise it for very large lists; 0 disables the pause.", "default": 400 } } }, "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 } } } } } } } } } }