Skip to content
TipPage Docs
Esc
↑↓navigate↵open⌘Jpreview

Who am I

Returns the streamer this credential belongs to and the credential itself - an API key or an OAuth authorization, same shape either way. The first call to make when wiring up an integration.

GET/me
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
200

Credential and tenant identity.

tenantobject
Show properties
idstring
namestring
avatar_urlstring | null

The connected channel's picture (Twitch first, else Kick) - the one the tip page header shows.

currencystring

ISO 4217 code of the streamer's tip currency.

currency_symbolstring

Display symbol for that currency, as shown on the tip page. Use it when rendering amount fields anywhere in this API.

media_requestsboolean

Media requests are switched on for the channel. Off = the media queue never fills and there is nothing to pause or show on stream; an app can leave its media controls out.

credentialobject

What authenticated this request.

Show properties
typestring
Allowed:api_keyoauth
idstring

The key (ak_...) or, for an OAuth token, the authorization it acts under (oa_...).

namestring

The key's dashboard name, or the OAuth app's name.

scopesstring[]
oauthobject | null

The app behind an OAuth authorization; null for an API key.

Show properties
client_idstring
client_namestring
401

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

429

Rate limit exceeded - check the RateLimit-* headers.

errorstring
Try it
Server
Authorization
Request
curl -X GET 'https://api.tippage.com/v1/me' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "tenant": {
    "id": "t_a7f3b9c2",
    "name": "CallumFromTheCorner",
    "avatar_url": "string",
    "currency": "GBP",
    "currency_symbol": "£",
    "media_requests": true
  },
  "credential": {
    "type": "api_key",
    "id": "ak_1f2e3d4c5b6a",
    "name": "Discord bot",
    "scopes": [
      "tts:read",
      "tts:control"
    ]
  },
  "oauth": {
    "client_id": "oc_9f8e7d6c5b4a",
    "client_name": "Loadout Sync"
  }
}