Managed gateway · LeanPool

LIVE chat

Decoded chat, gift and room events.

GETapi.tikultra.com/v1/live/chatHeavy · 10 credits

Upstream/webcast/im/fetch/{ cursor, has_more }Every plan

Parameters

Name	Type	Description
`room_id`required	string	The numeric LIVE room ID. e.g. 7705861000123456789
`cursor`	string	The cursor from the previous page. Omit it for the first page.

Pricing

Plan	Per call	Per 1,000 calls
Starter	10 credits	$1.16
Growth	10 credits	$0.79
Scale	10 credits	$0.58

Response fields

Field	Type	Description
`status_code`	integer	Upstream TikTok mobile status code (0 indicates success).
`room_id`	string	64-bit LIVE room Snowflake identifier.
`cursor`	string	Opaque pagination cursor to pass as cursor on the next request, or null at the end.
`has_more`	boolean	Whether another page of results is available.
`events`	object[]	List of events objects.
`events[].type`	string	Decoded type value.
`events[].msg_id`	string	Unique msg identifier.
`events[].user`	object	Resolved user profile object.
`events[].text`	string	UTF-8 text body.
`events[].ts_ms`	integer	Ts in milliseconds.

Responses

A 200 returns JSON with stable field names. Every response carries x-credits-cost, x-credits-tier and x-credits-remaining. Errors return a JSON body with a stable code and cost 0 credits. Error codes

import os
from tikultra import TikUltra

with TikUltra(api_key=os.environ["TIKULTRA_KEY"]) as client:
    res = client.request("GET", "/v1/live/chat", params={
        "room_id": "7705861000123456789",
    })
    print(res.credits_cost, res.data)

{
  "status_code": 0,
  "room_id": "7705861000123456789",
  "cursor": "1794400815000_9912",
  "has_more": true,
  "events": [
    {
      "type": "WebcastChatMessage",
      "msg_id": "7705861999111222333",
      "user": {
        "uid": "6970000000000000002",
        "unique_id": "kbfan",
        "nickname": "KB Fan"
      },
      "text": "Try the POM plate next!",
      "ts_ms": 1794400812410
    },
    {
      "type": "WebcastGiftMessage",
      "msg_id": "7705861999111222334",
      "user": {
        "uid": "6970000000000000003",
        "unique_id": "deskminimal",
        "nickname": "Desk Minimal"
      },
      "gift_id": 5879,
      "gift_name": "Doughnut",
      "diamond_count": 30,
      "repeat_count": 2,
      "ts_ms": 1794400814105
    }
  ]
}

Try it in the playground Full reference in the docs

More in LIVE rooms

GET/v1/live/roomLIVE room10 cr GET/v1/live/check-aliveIs LIVE5 cr GET/v1/live/with-chatLIVE room with chat10 cr GET/v1/live/streamLIVE stream URLs10 cr GET/v1/live/audienceLIVE audience10 cr GET/v1/live/rankingLIVE hourly ranking10 cr GET/v1/live/giftsLIVE gift catalog10 cr GET/v1/live/recommendedRecommended LIVE10 cr GET/v1/live/goody-bagGoody bag10 cr GET/v1/live/bag-itemsLIVE bag items10 cr

Ready to build?

Start with 2,500 free credits and test every public endpoint, then pick a plan.

Get an API key See pricing