# 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:** 1 total users, 0 monthly users, 100.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 web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows.
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.

- **AI agents and MCP clients** — the [Apify MCP server](https://docs.apify.com/integrations/mcp.md) at `https://mcp.apify.com` (remote, streamable HTTP, OAuth on first use).
- **Agentic workflows and local Actor development** — [Agent Skills](https://apify.com/.well-known/agent-skills/index.json) with the [Apify CLI](https://docs.apify.com/cli/docs.md): `npm install -g apify-cli`, then `apify login`.
- **JavaScript/TypeScript projects** — the official [JS/TS client](https://docs.apify.com/api/client/js/docs.md): `npm install apify-client`.
- **Python projects** — the official [Python client](https://docs.apify.com/api/client/python/docs.md): `pip install apify-client`.
- **Any other language** — 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 '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_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 '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# 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 <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/WHdfdJEbgC1ffWZYS/builds/zYBr1Rd47XmhvHcKe/openapi.json