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

200Bot 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 | any

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

any

any

kickBotPlatform | any

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

any

any

401Missing 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`).

429Rate limit exceeded - check the `RateLimit-*` headers.

errorstring

Request

curl -X GET "https://api.tippage.com/v1/bot" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://api.tippage.com/v1/bot", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://api.tippage.com/v1/bot",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "bot": {
    "enabled": true,
    "platforms": {
      "twitch": {
        "enabled": true,
        "channel": "somestreamer",
        "identity": {
          "type": "default",
          "login": "tippagebot",
          "display_name": "TipPageBot"
        }
      },
      "kick": {
        "enabled": true,
        "channel": "somestreamer",
        "identity": {
          "type": "default",
          "login": "tippagebot",
          "display_name": "TipPageBot"
        }
      }
    }
  }
}