Object
LiveRoom object
A live room as it is now: whether it is on, its title, host, start time and room-level counts. The same fields on every platform. A field a platform does not show is null, and meta.unavailable names it with the reason.
| Field | Type | From view | Description |
|---|---|---|---|
id | string | null | compact | The room's ID; the endpoints that read a room take it. Null where the platform names no room: an account that is not live, or a board entry that links to the host only. |
url | string | null | compact | The room's web page; null where the platform gives the room none. |
status | string | compact | live: streaming now. offline: not streaming (the other fields then describe the last session, where the platform still shows it). |
title | string | null | compact | The room's title as the host set it. |
category | string | null | compact | The room's category or game, in the platform's words (Twitch's game, Bilibili's area); null where the platform gives none. |
cover_url | string | null | standard | Cover image. |
host | AccountRef | compact | The host's public account. |
started_at | string | null | compact | When the current (or last) session started, ISO 8601 in UTC. |
rank | integer | null | compact | Place on the board, from 1; null outside boards. |
metrics | LiveMetrics | compact | Room-level counts at fetch time; a count the platform does not show is null. |
ext | object | full | Platform-specific extras. Only returned with view=full. · only with view=full |
AccountRef
| Field | Type | Description |
|---|---|---|
id | string | Account ID on the platform. |
username | string | null | Handle, where the platform has one. |
name | string | null | Display name. |
avatar_url | string | null | Avatar image URL. |
followers | integer | null | Follower count at fetch time. |
verified | boolean | null | Whether the platform shows a verification badge. |
LiveMetrics
| Field | Type | Description |
|---|---|---|
viewers | integer | null | People in the room right now. |
total_viewers | integer | null | People who have come into the room since it started; where the platform rounds it (100,000+), the lower bound. |
likes | integer | null | Likes since it started. |
heat | integer | null | The platform's own popularity score for the room, not a head count (Kuaishou's and Bilibili's). |
products | integer | null | Products on sale in the room (the shopping bag). |
Endpoints that return a LiveRoom
- TikTok account LIVE statustiktok.live.users.getLiveRoom$0.002/call
- Douyin live roomdouyin.live.rooms.getLiveRoom$0.002/call
- Douyin account live statusdouyin.live.users.getLiveRoom$0.004/call
- Kuaishou account live statuskuaishou.live.users.getLiveRoom$0.002/call
- Kuaishou live boardskuaishou.live.rooms.trendingLiveRoom[]$0.002/call
- WeChat Channels account live statuswechat_channels.live.users.getLiveRoom$0.02/call
- Bilibili live roombilibili.live.rooms.getLiveRoom$0.002/call
- Bilibili account live statusbilibili.live.users.getLiveRoom$0.002/call
- Twitch streamer live statustwitch.live.users.getLiveRoom$0.004/call
- WeChat Channels live roomwechat_channels.live.rooms.getLiveRoom$0.02/call