overlays.app API DEV · Test

TikTok Live — Room-Info, Live-Status, Creator-Liga, Chat & Streams

prüfe…
Authentifizierung & Test

Trag deinen API-Key ein, dann kannst du unten jeden Endpunkt direkt testen. Auth per Authorization: Bearer <key>, x-api-key oder ?apiKey=. Handles mit/ohne @ oder als TikTok-URL.

🔍 TikToker-Übersicht

Gib einen @handle (oder eine TikTok-URL) ein — alle verfügbaren Infos erscheinen automatisch.

📚 API-Referenz

Health

Service-Status / Liveness-Check.

Anfrage testen

Keine Parameter.

Code

📺Room & Stream

Profil-/Room-Info, Live-Status und browserspielbare H.264-Stream-URLs.

Vollständige Room-Info (Nickname, Avatar, Follower, Liga, Live-Status) zu einem Handle.

Anfrage testen
Code

Löst roomId + Live-Status zu einem Handle auf.

Anfrage testen
Code

Cover-Bild der Live-Room.

Anfrage testen
Code

Live-Stream-URLs (H.264 HLS + FLV) — bevorzugt die browserspielbare Qualität.

Anfrage testen
Code

💬Chat & Live-Events

Chat-, Geschenk- und Like-Events einer Live-Room in Echtzeit.

Bootstrap-Daten für den Chat-Start (roomId, Cursor, initiale Payload).

Anfrage testen
Code

Chat-/Gift-/Like-Events einer Room, cursor-basiert weiterpollen.

Anfrage testen
Code

Live-Chat als Server-Sent-Events (SSE) — fertig dekodierte Nachrichten.

Anfrage testen
Code

🏆Creator-Liga & Wins

Liga-Rang (A1–D5), Score, Sterne und PK-Wins.

Creator-Liga: Liga-Stufe, Score, Sterne, Supporter, Fragment-Fortschritt. leagueTopPercent kommt (wenn verfügbar) autoritativ aus rank_class/info — leagueTopPercentSource sagt woher; leagueBrackets ist die Bracket-Leiter vom Server.

Anfrage testen
Code

Fragment-„Top X%" der Creator-Liga + Bracket-Leiter — die AUTORITATIVE Quelle. Genau die Zahlen, die TikTok im App-Dialog „Liga dieses Creators" zeigt.

ANTWORT: topPercent = exaktes Perzentil (z. B. 19) · currentBracket = { topPercent, fragments, bonusStars } die Stufe, in der man damit steht (19 % → „Top 20 %", +1 Fragment) · brackets[] = komplette Leiter VOM SERVER, z. B. [{10,+2},{20,+1},{80,0},{99,−1}] · creatorClass · fragments (aktuelle Fragmente) · isSettling · source. — ABGRENZUNG: topPercent aus /webcast/ranklist_league ist etwas ANDERES. Dort liefert TikTok je nach Streamer entweder ein echtes Perzentil oder nur die Ranglisten-PLATZZIFFER; für Fragment-Anzeigen deshalb IMMER diesen Endpoint bzw. leagueTopPercent aus ranklist_league nehmen (das wird intern bereits von hier überschrieben). — VORAUSSETZUNG: gültige TikTok-Session (npm run tt:login). Offline-Streamer → ok:false, offline:true; ohne Live-Room gibt es keine Fragment-Daten. Session abgelaufen → 502 rank_class_unavailable.

Anfrage testen
Code

PK-Wins / Win-Streak eines Creators.

Anfrage testen
Code

🎁Galerie, Ranking & Gifts

Live-Geschenkgalerie, Fan-Ranking und Gift-Katalog.

Geschenkgalerie der Room (Gifts, Ziele, Title Gifter, Diamanten).

Anfrage testen
Code

Fan-/Supporter-Ranking (Top-Gifter) der Live-Room.

Anfrage testen
Code

Gift-Katalog (Namen, Bilder, Diamanten).

Anfrage testen
Code

🔎Nutzer-Auflösung

userId → Handle / Name / Avatar und umgekehrt — auch für maskierte Gifter.

userId → Handle, Anzeigename, Avatar, followerCount.

Anfrage testen
Code

Handle → numerische userId + Name.

Anfrage testen
Code

Bulk & Limits

Live-Status vieler Accounts in einem Request (nebenläufig geprüft).

Anfrage testen
Code

Aktuelle Rate-Limit-Stände / Konfiguration.

Anfrage testen

Keine Parameter.

Code