The alert on screen right now

What the overlay’s alert box is showing, as the overlay reported it, or null between alerts. Requires tts:read.

GET/alerts/now

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

200The current alert, or none.

alertCurrentAlert | any

Show properties

One of:

CurrentAlert

event_idstring | null

typestring | null

The payload type, e.g. `channel.cheer`.

platformstring

Allowed:twitchkick

namestring | null

tierstring | null

totalinteger | null

bitsinteger | null

viewersinteger | null

kicksinteger | null

monthsinteger | null

messagestring | null

profile_image_urlstring | null

is_replayboolean

started_atstring<date-time> | null

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

403The key lacks the required scope (`missing_scope`).

errorstringrequired

Human-readable message.

codestring

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

required_scopestring

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

errorstring

Request

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

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

import requests

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

Response

{
  "alert": {
    "event_id": "string",
    "type": "string",
    "platform": "twitch",
    "name": "string",
    "tier": "string",
    "total": 0,
    "bits": 0,
    "viewers": 0,
    "kicks": 0,
    "months": 0,
    "message": "string",
    "profile_image_url": "string",
    "is_replay": true,
    "started_at": "2019-08-24T14:15:22Z"
  }
}