{ "openapi": "3.0.1", "info": { "title": "TikTok Video Scraper Premium", "description": "Access TikTok video & slideshow data, transcribe videos and retrieve creator and music data, hashtags, likes, views, shares and mentions at scale. Download videos in bulk in native quality and subtitles as WebVTT or SRT. Export your data in JSON, CSV, Excel, RSS & more...", "version": "0.0", "x-build-id": "Xgc7EV1BIJDEYmzkI" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/radeance~tiktok-video-scraper-premium/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-radeance-tiktok-video-scraper-premium", "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/radeance~tiktok-video-scraper-premium/runs": { "post": { "operationId": "runs-sync-radeance-tiktok-video-scraper-premium", "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/radeance~tiktok-video-scraper-premium/run-sync": { "post": { "operationId": "run-sync-radeance-tiktok-video-scraper-premium", "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": [ "urls" ], "properties": { "urls": { "title": "TikTok Video URLs", "type": "array", "description": "Video URLs URLs to scrape. You can specify multiple URLs by clicking on the Add button or in bulk by clicking on the Bulk edit button.", "items": { "type": "string" } }, "download_videos": { "title": "Download Videos to Apify Storage", "type": "boolean", "description": "Downloads TikTok Videos to your Apify Storage. Access the downloadable file from the `downloadUrl` field. If disabled, only video information will be scraped.", "default": true }, "download_slideshows": { "title": "Download Slideshow Images to Apify Storage", "type": "boolean", "description": "Downloads TikTok Slideshow Images to your Apify Storage. Access the downloadable files from the `slideshowImages` field. If disabled, only slideshow information and image urls will be scraped.", "default": true }, "download_audio": { "title": "Download TikTok Music to Apify Storage", "type": "boolean", "description": "Downloads TikTok Audio to your Apify Storage. Access the downloadable file from the `music_download_url` field. If disabled, only audio information will be scraped.", "default": false }, "download_subtitles": { "title": "Download Subtitles to Apify Storage (if available)", "type": "boolean", "description": "Downloads TikTok Subtitles to your Apify Storage. Access the downloadable file from the `subtitlesUrl` field.. If disabled, only video information will be scraped.", "default": true }, "translate_subtitles": { "title": "Translate subtitles to preferred language (if available) | PROXY NEEDED", "type": "boolean", "description": "Translates TikTok Subtitles to your preferred language. Access the translation from the `subtitle_translation_webvtt` or `subtitle_translation_srt` fields.", "default": false }, "quality:": { "title": "Video Quality", "enum": [ "lowest", "720p", "1080p", "highest" ], "type": "string", "description": "Select the video quality you want to download. The higher the quality, the larger the file size. The highest quality is up to 1080p. Low files are around 1-2 MB, while high quality files can be up to 20 MB.", "default": "highest" }, "audio_format": { "title": "Audio Format", "enum": [ "mp4", "wav", "mp3" ], "type": "string", "description": "Select the audio format you want to download. MP4 is the native format of TikTok, choosing MP3 or WAV will convert the audio to the selected format. This will increase the processing time.", "default": "mp4" }, "subtitles_format": { "title": "Subtitles Format", "enum": [ "webvtt", "srt" ], "type": "string", "description": "Select the format of the subtitles you want to download. The WebVTT format is recommended for most use cases.", "default": "webvtt" }, "preferred_language": { "title": "Preferred Language for Subtitles", "enum": [ "na", "en", "es", "fr", "de", "it", "pt", "ru", "ja", "ko", "zh" ], "type": "string", "description": "Select your preferred language for subtitles. If not available, the subtitles will be translated if option set to True or will be in the native language.", "default": "na" }, "storage_name": { "title": "Name of the Storage for Videos and Subtitles", "pattern": "^[a-zA-Z0-9-]+$", "minLength": 3, "maxLength": 32, "type": "string", "description": "Saves videos and subtitles to a specific storage name. It is recommended to use a unique name for longer storage retention. If not provided, your videos and subtitles will be saved for 7 days." } } }, "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 } } } } } } } } } }