Skip to content
TipPage Docs
Esc
navigateopen⌘Jpreview

What's playing right now

The TTS currently claimed as playing, if any. TTS audio has no known duration, so there is no live position - started_at is when the claim was made, which is enough to spot a consumer that died mid-item. Requires tts:read.

GET/tts/now
Authorization
AuthorizationBearer token (tp_live_...) · headerrequired
A TipPage API key, created in Dashboard → Settings → Developer.
Responses
200Current playback state.
playingboolean
A TTS is claimed as playing right now.
is_pausedboolean
tipQueueTip | any
Show properties
One of:
QueueTip
order_idstring
namestring
Display name (post-filter).
amountnumber | null
messagestring | null
The tip message (post-filter - what shows on stream).
tts_urlstring<uri> | null
Pre-rendered audio; `null` until rendering completes.
is_replayboolean
is_sub_rewardboolean
twitch_user_idstring | null
Present when the donor tipped signed in with Twitch.
name_was_filteredboolean
message_was_filteredboolean
queued_atstring<date-time>
any
any
started_atstring<date-time> | null
When the current TTS was claimed.
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`).
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/tts/now" \
  -H "Authorization: Bearer YOUR_TOKEN"
Response
{
  "playing": true,
  "is_paused": true,
  "tip": {
    "order_id": "tip_1755100000000_ab12cd",
    "name": "string",
    "amount": 5,
    "message": "string",
    "tts_url": "http://example.com",
    "is_replay": true,
    "is_sub_reward": true,
    "twitch_user_id": "string",
    "name_was_filtered": true,
    "message_was_filtered": true,
    "queued_at": "2019-08-24T14:15:22Z"
  },
  "started_at": "2019-08-24T14:15:22Z"
}