A viewer's sub-reward history
The viewer’s played sub-reward messages, most recent first - the same shape as /tts/history, filtered to this viewer’s sub rewards. Replays by the streamer are excluded; a sub reward still waiting to play shows up in /tts/queue like any other tip. Requires viewers:read.
/viewers/{user}/rewardsAuthorizationBearer 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.
userstringrequiredWhich viewer: <platform>:<id> (twitch:123456789, kick:123), a bare numeric id, or a login / display name (case-insensitive, matched on both platforms; URL-encode names with special characters). A bare id is tried on Twitch then Kick - if an account with that id has signed in on both, the answer is 409 ambiguous_viewer; a name shared by two different people is 409 too, while a name that matches both of ONE person's linked accounts resolves to the one they signed in with most recently. Prefer platform:id in automation - it survives renames and can never be ambiguous.
limitintegerbeforestringCursor - an order_id from a previous page (next_cursor). Returns rows strictly older than it.
One page of played sub rewards.
viewerViewerA viewer who has signed in to the tip page. platform + platform_user_id name the account they signed in with here; linked_accounts lists the person's other platform account(s), if they linked any (may be empty). Credits and reward history are read across the whole set.
Show propertiesHide properties
platformstringrequiredtwitchkickplatform_user_idstringrequiredloginstring | nulldisplay_namestring | nullprofile_image_urlstring<uri> | nullsubscriber_tierintegerTheir sub tier as last seen (0 = not subscribed).
0123first_signed_in_atstring<date-time>When they first signed in to this tip page.
last_active_atstring<date-time>Last account activity seen (profile refreshes included).
linked_accountsobject[]requiredThe person's OTHER platform accounts - never the one above. Empty when nothing is linked.
Show propertiesHide properties
objectplatformstringtwitchkickplatform_user_idstringloginstring | nulldisplay_namestring | nullrewardsHistoryTip[]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 | nullUnknown before cursor (bad_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_scopestringNo viewer with that name or id has ever signed in to this tip page (viewer_not_signed_in). Signing in on the tip page (Twitch or Kick) is what creates a viewer - until then they can't be looked up or granted credits.
errorstringrequiredHuman-readable message.
codestringMachine-readable code (e.g. missing_scope, not_in_queue).
More than one signed-in viewer matches (ambiguous_viewer) - two people share that name, or a bare id exists on both platforms. Retry with <platform>:<id>.
errorstringrequiredHuman-readable message.
codestringMachine-readable code (e.g. missing_scope, not_in_queue).
Rate limit exceeded - check the RateLimit-* headers.
errorstring