# TikTok LIVE API (`tiktools/tiktok-live-api`) Actor Detect live creators, pull room and creator data, gifts and leaderboards from any TikTok LIVE stream. Free tier included; full data at tik.tools. - **URL**: https://apify.com/tiktools/tiktok-live-api.md - **Developed by:** [TikTools](https://apify.com/tiktools) (community) - **Categories:** Social media, Developer tools - **Stats:** 2 total users, 1 monthly users, 0.0% runs succeeded, 0 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/docs.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python/docs.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/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 ## TikTok LIVE API Real-time data from any TikTok LIVE stream. Detect who is live, pull room and creator data, gifts, and regional leaderboards - all from one Actor. Powered by the [tik.tools](https://tik.tools) platform. The free tier here covers live detection, room data, gifts, and rankings so you can build today. Higher limits, full unmasked leaderboards, league and gaming boards, creator and gifter earnings intel, the eligible-creator recruiting feed, and the real-time event WebSocket are available direct at **[tik.tools/pricing](https://tik.tools/pricing)** - cheaper than metered marketplace pricing. ### What it does Pick a **Data type**, give it TikTok usernames (or a region), and get structured results in your dataset. | Data type | Needs | Returns | |---|---|---| | Is creator live | usernames | Live status, room id, viewers, title | | Instant live status | usernames | Zero-latency liveness flag | | Room info | usernames | Host profile, title, viewer count, start time | | Room cover image | usernames | Stream thumbnail URL | | In-room rankings | usernames | Top gifters and audience ranking for the room | | Creator gift gallery | usernames | The creator's pre-live gift wishlist | | Creator profile | usernames | Full creator profile (Pro tier) | | Creator earnings | usernames | Diamonds and coin equivalent (Basic tier) | | Global gift catalog | - | Every gift, diamond cost, icon, id | | Live feed by region | region | Currently live streams in a region (Pro tier) | | Popular LIVE board | region | TikTok's real-time featured-creator board (Agency tier) | | Eligible creators to recruit | region | Score-ranked creators to recruit (Agency tier) | ### Input ```json { "endpoint": "check_alive", "usernames": ["tv_asahi_news", "charlidamelio"], "region": "US", "maxItems": 0 } ```` - **endpoint** - which data type to fetch (see the table above) - **usernames** - TikTok usernames without the @, one per line (per-creator types) - **region** - region code for the region types (for example `US`, `KR`, `DE`) - **maxItems** - cap the number of results, `0` for no cap ### Output One dataset item per creator (or one per region call). Example: ```json { "username": "tv_asahi_news", "endpoint": "check_alive", "httpStatus": 200, "data": [{ "alive": true, "room_id": "7300000000000000000", "userCount": 12480 }], "_upgrade": "https://tik.tools/pricing" } ``` ### Free tier and upgrading The free tier returns the sandbox surface: live detection, room data, gifts, and rankings, plus masked previews of the premium boards. Pro, Agency, and higher unlock the full unmasked data, higher request limits, and the real-time event WebSocket (chat, gifts, battles, captions) - get them direct at **[tik.tools/pricing](https://tik.tools/pricing)**. ### Links - Platform and pricing: https://tik.tools - Full API docs and live examples: https://tik.tools/docs # Actor input Schema ## `endpoint` (type: `string`): What to fetch. Per-creator types use the Usernames list. Region types (Popular LIVE, Eligible creators, Live feed) use the Region field. Some types are limited on the free tier and unlock in full at https://tik.tools/pricing. ## `usernames` (type: `array`): TikTok usernames without the @, one per line. Used by the per-creator data types. ## `region` (type: `string`): Region code for the Popular LIVE, Eligible creators and Live feed types (for example US, KR, DE). ## `maxItems` (type: `integer`): Cap the number of items returned. 0 = no cap. ## Actor input object example ```json { "endpoint": "check_alive", "usernames": [ "tv_asahi_news" ], "region": "", "maxItems": 0 } ``` # 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 = { "usernames": [ "tv_asahi_news" ] }; // Run the Actor and wait for it to finish const run = await client.actor("tiktools/tiktok-live-api").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 = { "usernames": ["tv_asahi_news"] } # Run the Actor and wait for it to finish run = client.actor("tiktools/tiktok-live-api").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 '{ "usernames": [ "tv_asahi_news" ] }' | apify call tiktools/tiktok-live-api --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=tiktools/tiktok-live-api", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "TikTok LIVE API", "description": "Detect live creators, pull room and creator data, gifts and leaderboards from any TikTok LIVE stream. Free tier included; full data at tik.tools.", "version": "0.1", "x-build-id": "zYBr1Rd47XmhvHcKe" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tiktools~tiktok-live-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tiktools-tiktok-live-api", "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/tiktools~tiktok-live-api/runs": { "post": { "operationId": "runs-sync-tiktools-tiktok-live-api", "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/tiktools~tiktok-live-api/run-sync": { "post": { "operationId": "run-sync-tiktools-tiktok-live-api", "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": { "endpoint": { "title": "Data type", "enum": [ "check_alive", "live_status", "room_info", "room_cover", "rankings", "gift_gallery", "user_profile", "user_earnings", "gift_info", "feed", "popular", "eligible_creators" ], "type": "string", "description": "What to fetch. Per-creator types use the Usernames list. Region types (Popular LIVE, Eligible creators, Live feed) use the Region field. Some types are limited on the free tier and unlock in full at https://tik.tools/pricing.", "default": "check_alive" }, "usernames": { "title": "TikTok usernames", "type": "array", "description": "TikTok usernames without the @, one per line. Used by the per-creator data types.", "items": { "type": "string" } }, "region": { "title": "Region", "type": "string", "description": "Region code for the Popular LIVE, Eligible creators and Live feed types (for example US, KR, DE).", "default": "" }, "maxItems": { "title": "Max results", "type": "integer", "description": "Cap the number of items returned. 0 = no cap.", "default": 0 } } }, "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 } } } } } } } } } } ```