# LiveRoom

> A live room as it is now: whether it is on, its title, host, start time and room-level counts.

Canonical page: https://okdata.online/docs/objects/live_room/

The same shape on every platform. A field a platform does not have is null, and meta.unavailable says why. Use fields= to keep only what you need.

| Field | Type | Description |
|---|---|---|
| `id` | string \| null | 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 | The room's web page; null where the platform gives the room none. |
| `status` | string | live: streaming now. offline: not streaming (the other fields then describe the last session, where the platform still shows it). |
| `title` | string \| null | The room's title as the host set it. |
| `category` | string \| null | 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 | Cover image. |
| `host` | AccountRef | The host's public account. |
| `started_at` | string \| null | When the current (or last) session started, ISO 8601 in UTC. |
| `rank` | integer \| null | Place on the board, from 1; null outside boards. |
| `metrics` | LiveMetrics | Room-level counts at fetch time; a count the platform does not show is null. |
| `ext` | object | Platform-specific extras. Only returned 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 status](https://okdata.online/apis/tiktok/live/users/get/) (`tiktok.live.users.get`): $0.002 per call
- [Douyin live room](https://okdata.online/apis/douyin/live/rooms/get/) (`douyin.live.rooms.get`): $0.002 per call
- [Douyin account live status](https://okdata.online/apis/douyin/live/users/get/) (`douyin.live.users.get`): $0.004 per call
- [Kuaishou account live status](https://okdata.online/apis/kuaishou/live/users/get/) (`kuaishou.live.users.get`): $0.002 per call
- [Kuaishou live boards](https://okdata.online/apis/kuaishou/live/rooms/trending/) (`kuaishou.live.rooms.trending`): $0.002 per call · about 50 results per page
- [WeChat Channels account live status](https://okdata.online/apis/wechat_channels/live/users/get/) (`wechat_channels.live.users.get`): $0.02 per call
- [Bilibili live room](https://okdata.online/apis/bilibili/live/rooms/get/) (`bilibili.live.rooms.get`): $0.002 per call
- [Bilibili account live status](https://okdata.online/apis/bilibili/live/users/get/) (`bilibili.live.users.get`): $0.002 per call
- [Twitch streamer live status](https://okdata.online/apis/twitch/live/users/get/) (`twitch.live.users.get`): $0.004 per call
- [WeChat Channels live room](https://okdata.online/apis/wechat_channels/live/rooms/get/) (`wechat_channels.live.rooms.get`): $0.02 per call

## Fields by view

Each view includes the fields of the views above it. `view=compact` is the smallest; `full` adds platform extras under `ext`.

- compact: `id`, `url`, `status`, `title`, `category`, `host`, `started_at`, `rank`, `metrics`
- standard: `cover_url`
- full: `ext`
