# TikTok LIVE Studio Local Data Access

> A local WebSocket protocol that allows approved third-party applications on the creator machine to receive TikTok LIVE Studio likes, gifts, and chat events.

Protocol version: `1.0.0`. The endpoint is loopback-only at `ws://127.0.0.1:49152-65535/v1/third-party`. The port is selected dynamically and may change after restart; discover it with bounded parallel scanning and validate `SERVER_HELLO` before sending credentials. The public documentation is the source of truth.

## Start Here

- [Apply for Early Access](https://tiktok-live-studio-local-data-access.pages.dev/apply): International developers can submit their team, game, technology stack, requested event types, and pilot timeline for allowlist review
- [Overview](https://tiktok-live-studio-local-data-access.pages.dev/guide/overview): Product scope, prerequisites, and local-only deployment model
- [Quick Start](https://tiktok-live-studio-local-data-access.pages.dev/guide/quick-start): Minimum discovery, authentication, and event-receive flow
- [Architecture](https://tiktok-live-studio-local-data-access.pages.dev/guide/architecture): Recommended client boundaries and lifecycle
- [Agent Skill](https://tiktok-live-studio-local-data-access.pages.dev/guide/agent-skill): Install and use the reusable cross-stack coding-agent workflow

## Playable Demos

- [All Demos](https://tiktok-live-studio-local-data-access.pages.dev/demos/): Compare two real games built on the same local event protocol
- [Tug of Trap](https://tiktok-live-studio-local-data-access.pages.dev/demos/tug-of-trap): PixiJS team competition using chat selection, like strength, and tactical gift effects
- [Candy Arena](https://tiktok-live-studio-local-data-access.pages.dev/demos/candy-arena-duel): React and Phaser rhythm battle using audience assists and gift-triggered combat skills
- [Tug of Trap — simulated demo](https://liangpeiran-bit.github.io/playable_interaction_game/?demo=1): Public playable build with clearly labeled simulated interactions
- [Candy Arena — simulated demo](https://liangpeiran-bit.github.io/candy-arena-duel/?demo=1): Public playable build with clearly labeled simulated interactions

## Protocol

- [Connection Lifecycle](https://tiktok-live-studio-local-data-access.pages.dev/protocol/connection): Endpoint discovery, hello validation, native heartbeat, and reconnection
- [Authentication](https://tiktok-live-studio-local-data-access.pages.dev/protocol/auth): `SERVER_HELLO`, `AUTH`, and `AUTH_RESULT` contracts
- [Event Envelope](https://tiktok-live-studio-local-data-access.pages.dev/protocol/events): Common event shape, public user object, optional fields, and deduplication
- [Errors and Disconnects](https://tiktok-live-studio-local-data-access.pages.dev/protocol/errors): Authentication errors, disconnect reasons, and client retry behavior

## Events

- [live.like](https://tiktok-live-studio-local-data-access.pages.dev/events/live-like): Like payload and string count fields
- [live.gift](https://tiktok-live-studio-local-data-access.pages.dev/events/live-gift): Gift payload, combo fields, and gift object
- [Gift Catalog](https://tiktok-live-studio-local-data-access.pages.dev/reference/gift-catalog): Search and select gift IDs, then map them to application or game effects
- [Gift Catalog JSON](https://tiktok-live-studio-local-data-access.pages.dev/data/gifts.json): Machine-readable regional snapshot; match events by `gift.id`, never by name or price
- [live.chat](https://tiktok-live-studio-local-data-access.pages.dev/events/live-chat): Plain-text chat payload

## Agent Resources

- [Installable Agent Skill](https://github.com/liangpeiran-bit/tiktok-live-studio-local-data-access/tree/main/.agents/skills/tiktok-live-studio-local-data-access): Protocol-correct implementation, review, and troubleshooting workflow for any compatible technology stack
- [Complete English Context](https://tiktok-live-studio-local-data-access.pages.dev/llms-full.txt): Concatenated English documentation and Agent Skill source
- [Chinese LLM Index](https://tiktok-live-studio-local-data-access.pages.dev/zh/llms.txt): Chinese documentation map

## Optional

- [Troubleshooting](https://tiktok-live-studio-local-data-access.pages.dev/guide/troubleshooting): Discovery, authentication, event, and heartbeat diagnostics
- [JavaScript and TypeScript Sample](https://tiktok-live-studio-local-data-access.pages.dev/samples/javascript): Browser or Node-oriented example
- [Unity Sample](https://tiktok-live-studio-local-data-access.pages.dev/samples/unity): Unity integration example
- [H5 Overlay Sample](https://tiktok-live-studio-local-data-access.pages.dev/samples/h5): Local browser overlay example and credential caveats
- [GitHub Repository](https://github.com/liangpeiran-bit/tiktok-live-studio-local-data-access): Documentation and Agent Skill source

## Onboarding and support

- [Choose an event](https://tiktok-live-studio-local-data-access.pages.dev/events/): Compare like, gift, and chat integration patterns.
- [Runnable H5 starter](https://tiktok-live-studio-local-data-access.pages.dev/samples/h5): Download, run locally, enter credentials, and verify the first event.
- [Local client source](https://tiktok-live-studio-local-data-access.pages.dev/samples/local-client.mjs): Bounded discovery, authentication, cancellation, and event deduplication.
- [Tower Defense video case](https://tiktok-live-studio-local-data-access.pages.dev/demos/tower-defense): Recording, not a playable game.
- [English search aliases](https://tiktok-live-studio-local-data-access.pages.dev/data/gift-aliases.json): Documented example aliases, not official global names.
- [Contact support](mailto:TikTok_LIVE_Studio_Office@bytedance.com): Access and integration help; never send secrets. Review results arrive by email, with no guaranteed turnaround.