Endpoint list
Every endpoint a bot can call, with method, path, and the permission each one needs.
Tokens
The OAuth endpoints for issuing, refreshing, and revoking access tokens.
Read the current broadcast
GET /v1/live — the broadcast title, start and end times, listener count, and chat-frozen state.
List listeners
GET /v1/live/listeners — page through the id and nickname of the listeners currently in the room.
Read the fan ranking
GET /v1/live/fans — the top 30 donors of this broadcast, among the listeners currently in the room.
Event stream
GET /v1/live/events — receive chat, joins, hearts, and donations over SSE, with the payload spec for all five events.
Send chat
POST /v1/live/chat — post chat to the broadcast under the bot account's name.
Error codes
The error response format of the bot API and how to handle each code you will actually meet.