# TikTok Live Audience Recorder(Stealth) (`thejoshualab/tiktok-live-recorder`) Actor

Connects to active TikTok live streams to log viewer comments, joins, and gifts. Features a built-in React UI dashboard. No login needed

- **URL**: https://apify.com/thejoshualab/tiktok-live-recorder.md
- **Developed by:** [The Joshua Lab](https://apify.com/thejoshualab) (community)
- **Categories:** Social media, Automation
- **Stats:** 2 total users, 0 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $0.02 / 1,000 tiktok events

This Actor is paid per event and usage. You are charged both the fixed price for specific events and for Apify platform usage.

Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event

## 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 Audience Logger

Connects to active TikTok Live streams and logs all viewer activity (chat messages, member joins, and gifts) in real-time. Includes a built-in web dashboard for starting, stopping, and monitoring recording sessions.

**How it works**: The actor starts an Express web server with a control dashboard. When you start a recording, it spawns a child process (`live.js`) that connects to the TikTok Live stream via the `tiktok-live-connector` library and logs every event to a JSON file plus the Apify Key-Value Store. A generated HTML page provides a live-updating view of all captured events.

> **Note**: This actor does NOT use a browser or TikTok session cookies. It connects to TikTok's WebSocket-based live stream API directly using the `tiktok-live-connector` library.

### Input Parameters

| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| `username` | String | No | — | If provided, the actor will immediately begin logging this user's livestream on startup (auto-start mode). |
| `durationSeconds` | Integer | No | — | Auto-stop timer in seconds. The logger will automatically stop after this duration. Only applies when `username` is provided. |
| `port` | Integer | No | `4321` | Custom port for the web dashboard server. On the Apify platform, this is overridden by the `ACTOR_WEB_SERVER_PORT` environment variable. |

### Web Dashboard

The actor serves three pages:

- **`/`** — Main landing page (TikTok Live Engine). Enter a username and start recording from here.
- **`/admin`** — Command Center. View all active and past recording sessions, start/stop loggers, and export session data.
- **`/<username>_live_<date>.html`** — Live session viewer. Auto-refreshing page showing real-time chat, joins, and gifts for an active recording.

#### Dashboard API Endpoints

| Endpoint | Method | Description |
|---|---|---|
| `/start` | POST | Start logging a livestream. Body: `{ "username": "..." }` |
| `/stop` | POST | Stop a specific logger. Body: `{ "username": "..." }` |
| `/stop-all` | POST | Stop all active loggers. |
| `/status` | GET | Returns status of all active loggers (username, PID, HTML file). |
| `/loggers` | GET | Lists all generated session files (HTML + JSON). |
| `/export/:filename` | GET | Download a session file (JSON or HTML). |

### Output

- **Local files**: For each recording session, a JSON log file (`<username>_live_<date>.json`) and an HTML viewer file (`<username>_live_<date>.html`) are generated in the project root.
- **Key-Value Store**: Both the JSON log and HTML viewer are synced to a named Key-Value Store called `tiktok-live-logs`, which persists across runs on the Apify platform.
- **Dataset**: Each viewer interaction (chat, join, gift) is pushed as a dataset entry with `liveHost`, `viewer`, `event`, `comment`, and `timestamp`.

### Running Locally

```bash
cd tiktok-live-recorder
apify run
```

Then open `http://localhost:4321` in your browser to access the dashboard. From there you can enter any TikTok username that is currently live and start recording.

#### On Apify Platform

The dashboard is accessible via the actor's **Live View** URL (shown in the Apify console after the run starts). You can also use the `username` input to auto-start recording without opening the dashboard.

# Actor input Schema

## `username` (type: `string`):

If provided, the actor will immediately begin logging this livestream on startup.

## `durationSeconds` (type: `integer`):

Number of seconds to log the livestream before automatically stopping. Ignored if no Username is provided.

## `port` (type: `integer`):

Custom port to run the web server on (overridden by ACTOR\_WEB\_SERVER\_PORT on Apify platform).

## Actor input object example

```json
{
  "port": 4321
}
```

# Actor output Schema

## `dataset` (type: `string`):

Link to the dataset containing all logged webcast events.

# 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 = {};

// Run the Actor and wait for it to finish
const run = await client.actor("thejoshualab/tiktok-live-recorder").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 = {}

# Run the Actor and wait for it to finish
run = client.actor("thejoshualab/tiktok-live-recorder").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{}' |
apify call thejoshualab/tiktok-live-recorder --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,thejoshualab/tiktok-live-recorder"
        }
    }
}

```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

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