For AI

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.

FieldTypeFrom viewDescription
idstring | nullcompactThe 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.
urlstring | nullcompactThe room's web page; null where the platform gives the room none.
statusstringcompactlive: streaming now. offline: not streaming (the other fields then describe the last session, where the platform still shows it).
titlestring | nullcompactThe room's title as the host set it.
categorystring | nullcompactThe room's category or game, in the platform's words (Twitch's game, Bilibili's area); null where the platform gives none.
cover_urlstring | nullstandardCover image.
hostAccountRefcompactThe host's public account.
started_atstring | nullcompactWhen the current (or last) session started, ISO 8601 in UTC.
rankinteger | nullcompactPlace on the board, from 1; null outside boards.
metricsLiveMetricscompactRoom-level counts at fetch time; a count the platform does not show is null.
extobjectfullPlatform-specific extras. Only returned with view=full. · only with view=full

AccountRef

FieldTypeDescription
idstringAccount ID on the platform.
usernamestring | nullHandle, where the platform has one.
namestring | nullDisplay name.
avatar_urlstring | nullAvatar image URL.
followersinteger | nullFollower count at fetch time.
verifiedboolean | nullWhether the platform shows a verification badge.

LiveMetrics

FieldTypeDescription
viewersinteger | nullPeople in the room right now.
total_viewersinteger | nullPeople who have come into the room since it started; where the platform rounds it (100,000+), the lower bound.
likesinteger | nullLikes since it started.
heatinteger | nullThe platform's own popularity score for the room, not a head count (Kuaishou's and Bilibili's).
productsinteger | nullProducts on sale in the room (the shopping bag).

Endpoints that return a LiveRoom

Connect once, then just ask.

Every new key comes with $0.10 to try it. One sentence connects your agent.

Start free
Connect your AI

Paste this into your agent

Read https://okdata.online/agents.md and set up okdata for me; my key is in the OKDATA_API_KEY environment variable.

Claude Code, Cursor, Codex and other agents that can open a link set themselves up from it.

MCP serverhttps://api.okdata.online/mcp