Skip to main content
Returns a range of metadata around a (specified) user’s channel that can be accessed via multiple different variable members for each unique piece of information.

Example Usage

  • A command with the name !chatters and a response of the following:
    If triggered, could return the following response:
  • A command with the name !randomchatter and a response of the following:
    If triggered, could return the following response:

$(chatters)

Returns the same as $(chatters.count), the number of users currently connected to this chat room.

Parameters

This variable does not take any parameters.

Example Output

  • $(chatters)

Error Output

  • In case Fossabot does not have access to the chatters list, returns the following:
  • In case there is an unexpected Twitch API error.

$(chatters.count)

Returns the number of users currently connected to this chat room.

Parameters

This variable does not take any parameters.

Example Output

  • $(chatters.count)

Error Output

  • In case Fossabot does not have access to the chatters list, returns the following:
  • In case there is an unexpected Twitch API error.

$(chatters.random)

Returns the same as $(chatters.random.display_name), the uppercase version, or internationalized version of a user’s username of a user connected to this chat room.

Parameters

This variable does not take any parameters.

Example Output

  • $(chatters.random)

Error Output

  • In case Fossabot does not have access to the chatters list, returns the following:
  • In case there is no one connected to chat, returns the following:
  • In case there is an unexpected Twitch API error, returns the following:

$(chatters.random.display_name)

Returns the uppercase version, or internationalized version of a user’s username of a user connected to this chat room.

Parameters

This variable does not take any parameters.

Example Output

  • $(chatters.random.display_name)

Error Output

  • In case Fossabot does not have access to the chatters list, returns the following:
  • In case there is no one connected to chat, returns the following:
  • In case there is an unexpected Twitch API error, returns the following:

$(chatters.random.login)

Returns the lowercase username of a random user connected to this chat room.

Parameters

This variable does not take any parameters.

Example Output

  • $(chatters.random.login)

Error Output

  • In case Fossabot does not have access to the chatters list, returns the following:
  • In case there is no one connected to chat, returns the following:
  • In case there is an unexpected Twitch API error, returns the following:

$(chatters.random.provider_id)

Returns the platform ID of a random user connected to this chat room.

Parameters

This variable does not take any parameters.

Example Output

  • $(chatters.random.provider_id)

Error Output

  • In case Fossabot does not have access to the chatters list, returns the following:
  • In case there is no one connected to chat, returns the following:
  • In case there is an unexpected Twitch API error, returns the following: