# TikTok Video Downloader BetaVersion (`yoapi/tiktok-video-downloader-selfhosted`) Actor Beta version, can contains some bugs, please contact in case of bugs for we improve it. - **URL**: https://apify.com/yoapi/tiktok-video-downloader-selfhosted.md - **Developed by:** [Yo](https://apify.com/yoapi) (community) - **Categories:** Videos, Social media, Automation - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, NaN bookmarks - **User rating**: No ratings yet ## Pricing Pay per usage This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-usage ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README Readme will be updated later # Actor input Schema ## `url` (type: `string`): Single TikTok video URL to process. ## `urls` (type: `array`): List of TikTok video URLs to process. ## `output` (type: `string`): Desired output format. ## `quality` (type: `string`): Preferred video quality. ## `watermarkPolicy` (type: `string`): How watermark handling should work. ## `extractSubtitles` (type: `boolean`): Whether to extract subtitles when available. ## `metadataOnly` (type: `boolean`): Extract only metadata without downloading media. ## `cookies` (type: `string`): Optional cookies as a JSON array string. ## Actor input object example ```json { "url": "https://www.tiktok.com/@user/video/1234567890123456789", "urls": [ "https://www.tiktok.com/@user/video/1234567890123456789" ], "output": "mp4", "quality": "best", "watermarkPolicy": "standard", "extractSubtitles": false, "metadataOnly": false, "cookies": "[]" } ```` # Actor output Schema ## `results` (type: `string`): No description ## `file` (type: `string`): No description # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "url": "https://www.tiktok.com/@user/video/1234567890123456789", "urls": [ "https://www.tiktok.com/@user/video/1234567890123456789" ], "cookies": "[]" }; // Run the Actor and wait for it to finish const run = await client.actor("yoapi/tiktok-video-downloader-selfhosted").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "url": "https://www.tiktok.com/@user/video/1234567890123456789", "urls": ["https://www.tiktok.com/@user/video/1234567890123456789"], "cookies": "[]", } # Run the Actor and wait for it to finish run = client.actor("yoapi/tiktok-video-downloader-selfhosted").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "url": "https://www.tiktok.com/@user/video/1234567890123456789", "urls": [ "https://www.tiktok.com/@user/video/1234567890123456789" ], "cookies": "[]" }' | apify call yoapi/tiktok-video-downloader-selfhosted --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=yoapi/tiktok-video-downloader-selfhosted", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "TikTok Video Downloader BetaVersion", "description": "Beta version, can contains some bugs, please contact in case of bugs for we improve it.", "version": "1.2", "x-build-id": "9b4HPgOQ7nQy9WUEn" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/yoapi~tiktok-video-downloader-selfhosted/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-yoapi-tiktok-video-downloader-selfhosted", "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/yoapi~tiktok-video-downloader-selfhosted/runs": { "post": { "operationId": "runs-sync-yoapi-tiktok-video-downloader-selfhosted", "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/yoapi~tiktok-video-downloader-selfhosted/run-sync": { "post": { "operationId": "run-sync-yoapi-tiktok-video-downloader-selfhosted", "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": { "url": { "title": "TikTok URL (single)", "type": "string", "description": "Single TikTok video URL to process." }, "urls": { "title": "TikTok URLs (batch)", "type": "array", "description": "List of TikTok video URLs to process.", "items": { "type": "string" } }, "output": { "title": "Output format", "enum": [ "mp4", "mp3", "photos_zip" ], "type": "string", "description": "Desired output format.", "default": "mp4" }, "quality": { "title": "Video quality", "enum": [ "best", "1080", "720", "480" ], "type": "string", "description": "Preferred video quality.", "default": "best" }, "watermarkPolicy": { "title": "Watermark policy", "enum": [ "standard", "require_none" ], "type": "string", "description": "How watermark handling should work.", "default": "standard" }, "extractSubtitles": { "title": "Extract subtitles", "type": "boolean", "description": "Whether to extract subtitles when available.", "default": false }, "metadataOnly": { "title": "Metadata only", "type": "boolean", "description": "Extract only metadata without downloading media.", "default": false }, "cookies": { "title": "TikTok cookies", "type": "string", "description": "Optional cookies as a JSON array string.", "default": "[]" } } }, "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 } } } } } } } } } } ```