v1

latestOpenAPI 3.0.22026-07-1715222.2 KB

Extension State

Get All State

Returns a single JSON object with fields for the current viewer/channel combination.

get/all_state

Response

All types of state for the current viewer.

extensionobject

State for all viewers and channels for this extension.

channelobject

State for all viewers on this channel.

viewerobject

State for this viewer on this channel.

extension_viewerobject

State for this viewer on any channel using this extension.

Example response

{
  "extension": {
    "extension_name": "Awesome Extension"
  },
  "channel": {
    "channel_color": "royalpurple"
  },
  "viewer": {
    "last_broadcaster_request": "sing a song"
  },
  "extension_viewer": {
    "accumulated_points": 123456
  }
}