Grant credits
Grants sub-reward credits to a signed-in viewer - the same operation as the dashboard’s grant form; the credits appear on the viewer’s tip page immediately. Credits can only be granted to viewers who have signed in at least once: an unknown name or id answers 404 viewer_not_signed_in, and nothing is granted. Requires viewers:manage.
/viewers/{user}/credits/grantAuthorizationBearer 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.
application/jsonamountintegerrequiredCredits to grant.
Granted; the fresh balance is returned.
successbooleangrantedintegerviewerViewerA 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 | nullcreditsCreditBalanceA viewer's sub-reward credit balance.
Show propertiesHide properties
availableintegerCredits spendable right now.
totalintegerCredits ever granted.
usedintegerCredits already spent.
amount isn't an integer from 1 to 100 (bad_request).
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