Played TTS history
TTS entries that finished playing, most recent first, cursor-paginated. Requires tts:read.
/tts/historyAuthorizationBearer token (tp_live_... or tpat_...) · headerrequiredA 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.
limitintegerbeforestringCursor - an order_id from a previous page (next_cursor). Returns rows strictly older than it.
One page of history.
tipsHistoryTip[]Show propertiesHide properties
HistoryTiporder_idstringnamestringamountnumber | nullmessagestring | nulltts_urlstring<uri> | nullis_replaybooleanis_sub_rewardbooleansourcestringWhere the tip came from: stripe, paypal, manual (dashboard manual tip), api (POST /tips), sub_reward, replay, test, ayupcc, or unknown for tips older than source tracking.
external_sourcestring | nullDeveloper-API tips only - the source label the caller sent (kofi, ayupcc); null for every other source. Says where the tip came from, not whether money moved - see is_paid.
external_refstring | nullDeveloper-API tips only - the caller's own payment reference.
is_paidbooleanReal money changed hands (Stripe, PayPal, or a developer-API tip sent with paid: true). false for manual tips, free integration tips and sub rewards - those never count toward the streamer's totals.
platformstring | nullPlatform of the signed-in donor
twitchkicknullplatform_user_idstring | nullThe donor's id on that platform
name_was_filteredbooleanmessage_was_filteredbooleanqueued_atstring<date-time>When the tip entered the queue.
played_atstring<date-time>When it finished playing on stream.
has_morebooleannext_cursorstring | nullPass as ?before= to fetch the next page.
Unknown cursor.
errorstringrequiredHuman-readable message.
codestringMachine-readable code (e.g. missing_scope, not_in_queue).
Missing or invalid credential (missing_api_key / invalid_api_key, or invalid_token for an expired/revoked OAuth access token).
errorstringrequiredHuman-readable message.
codestringMachine-readable code (e.g. missing_scope, not_in_queue).
The key lacks the required scope (missing_scope).
errorstringrequiredHuman-readable message.
codestringMachine-readable code (e.g. missing_scope, not_in_queue).
required_scopestringRate limit exceeded - check the RateLimit-* headers.
errorstring