Bot status

Whether the chat bot is switched on, the channels it’s in (Twitch and/or Kick), and the identity it speaks as on Twitch - the shared TipPageBot or the streamer’s linked custom bot. On Kick the bot is always the TipPage app account. 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 for at least one platform (see `platforms` for each).

channelstring | null

The streamer's Twitch login (`null` without a Twitch channel).

channelsobject

Every chat the bot is in, by platform - `null` = not connected.

Show properties

twitchstring | null

kickstring | null

platformsobject

Per platform: the bot's on/off switch there, the channel, and the identity it speaks as. On Kick the identity is always the TipPage app's bot account.

Show properties

twitchobject

Show properties

enabledboolean

channelstring | null

identityobject

kickobject

Show properties

enabledboolean

channelstring | null

identityobject

Who the bot's messages appear from.

Show properties

typestring

Allowed:defaultcustom

loginstring

display_namestring

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,
    "channel": "somestreamer",
    "channels": {
      "twitch": "somestreamer",
      "kick": "somestreamer"
    },
    "platforms": {
      "twitch": {
        "enabled": true,
        "channel": "string",
        "identity": {}
      },
      "kick": {
        "enabled": true,
        "channel": "string",
        "identity": {}
      }
    },
    "identity": {
      "type": "default",
      "login": "tippagebot",
      "display_name": "TipPageBot"
    }
  }
}