Skip to content
TipPage Docs
Esc
↑↓navigate↵open⌘Jpreview

Bot status

Whether the chat bot is switched on, and per platform (Twitch, Kick) the chat it’s in and the identity it speaks as - on Twitch the shared TipPageBot or the streamer’s linked custom bot, on Kick always the TipPage app account. A platform the streamer hasn’t connected is null. Any valid key.

GET/bot
Authorization
AuthorizationBearer token (tp_live_... or tpat_...) · headerrequired

A TipPage API key (tp_live_..., created in Dashboard → Settings → Developer) or an OAuth 2.0 access token (tpat_..., see the OAuth guide). Both carry the same scopes and are accepted on every endpoint.

Responses
200

Bot status.

botobject
Show properties
enabledboolean

The bot is switched on in at least one connected chat (see platforms for each).

platformsobject

One entry per platform - null when the streamer has no channel there.

Show properties
twitchBotPlatform | null
Show properties
One of:
BotPlatform
enabledboolean

The streamer's on/off switch for the bot in this chat.

channelstring

The streamer's login on this platform.

identityobject

Who the bot's messages appear from. On Kick always the TipPage app account (default).

Show properties
typestring
Allowed:defaultcustom
loginstring
display_namestring
null
null
kickBotPlatform | null
Show properties
One of:
BotPlatform
enabledboolean

The streamer's on/off switch for the bot in this chat.

channelstring

The streamer's login on this platform.

identityobject

Who the bot's messages appear from. On Kick always the TipPage app account (default).

Show properties
typestring
Allowed:defaultcustom
loginstring
display_namestring
null
null
401

Missing or invalid credential (missing_api_key / invalid_api_key, or invalid_token for an expired/revoked OAuth access token).

errorstringrequired

Human-readable message.

codestring

Machine-readable code (e.g. missing_scope, not_in_queue).

429

Rate limit exceeded - check the RateLimit-* headers.

errorstring
Try it
Server
Authorization
Request
curl -X GET 'https://api.tippage.com/v1/bot' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "bot": {
    "enabled": true,
    "platforms": {
      "twitch": {
        "enabled": true,
        "channel": "somestreamer",
        "identity": {
          "type": "custom",
          "login": "somebot",
          "display_name": "SomeBot"
        }
      },
      "kick": {
        "enabled": false,
        "channel": "somestreamer",
        "identity": {
          "type": "default",
          "login": "tippagebot",
          "display_name": "TipPageBot"
        }
      }
    }
  }
}