Bot status

Whether the chat bot is switched on, the channel it lives in, and the identity it speaks as - the shared TipPageBot or the streamer’s linked custom bot. Any valid key.

GET/bot

Authorization

AuthorizationBearer token (tp_live_...) · headerrequired

A TipPage API key, created in Dashboard → Settings → Developer.

Responses

200Bot status.

botobject

Show properties

enabledboolean

The dashboard's bot on/off switch.

channelstring | null

The streamer's Twitch login.

identityobject

Who the bot's messages appear from.

Show properties

typestring

Allowed:defaultcustom

loginstring

display_namestring

401Missing or invalid API key (`missing_api_key` / `invalid_api_key`).

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",
    "identity": {
      "type": "default",
      "login": "tippagebot",
      "display_name": "TipPageBot"
    }
  }
}