Skip to main content
GET
List Live Chat
Read a stream’s chat. The chat stays between broadcasts, so it can be read while the user is offline.

Behavior

  • Without after, returns the newest 50 messages, oldest first. Poll with after set to the previous response’s last_id to get only new messages, again oldest first and up to 50 at a time. last_id counts messages that were left out, so a run of hidden messages never stalls your polling.
  • Pass the previous response’s now as since to learn which messages were removed since then: their ids come back in removed, at most 50. Drop them, or fetch the chat again to see them as removed; if 50 came back, fetch the chat again without after to catch any beyond that. See Pagination.
  • A removed message has deleted: true and body: null. deleted_by names who removed it, but only for the streamer, their moderators and staff; everyone else gets null. Messages deleted by their own author are left out entirely.
  • role is streamer or moderator for those authors, otherwise null.
  • reply_to quotes the message being replied to, with body: null and deleted: true if that message was removed. It is null if that message’s author deleted it.
  • Messages from users you blocked or who blocked you, and from suspended users, are left out.
  • restricted is timed_out or banned while that author is timed out or banned from this chat, otherwise null. It is only included for the streamer, their moderators and staff.
  • restriction says whether you yourself are timed out or banned here, with expires_at for a timeout and null for a ban. It is null when you can chat.
  • While the streamer has the chat turned off, chat_messages and removed are empty.
  • If the streamer blocked you, the response is 403 with type blocked.

Example

Authorizations

relay-key
string
header
required

Your relay key from snipp.gg/settings/relay

Path Parameters

id
string
required

User ID, or @me for your own account.

Query Parameters

after
integer

Only messages with an id greater than this, oldest first.

since
string<date-time>

Pass the previous response's now to get the ids of messages removed since then in removed.

Response

Success.

chat_messages
object[]
required
Maximum array length: 50
removed
integer[]
required
last_id
integer | null
required

The highest message id this response read, counting messages left out. Pass it as after on your next poll. null when the chat is empty.

now
string<date-time>
required
restriction
object | null
required

Whether you are timed out or banned from this chat. null when you can chat.