Skip to content
TipPage Docs
Esc
navigateopen⌘Jpreview

Who am I

Returns the streamer this key belongs to and the key’s own metadata. 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
200Key and tenant identity.
tenantobject
Show properties
idstring
namestring
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.
keyobject
Show properties
idstring
namestring
scopesstring[]
401Missing 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`).
429Rate limit exceeded - check the `RateLimit-*` headers.
errorstring
Request
curl -X GET "https://api.tippage.com/v1/me" \
  -H "Authorization: Bearer YOUR_TOKEN"
Response
{
  "tenant": {
    "id": "t_a7f3b9c2",
    "name": "CallumFromTheCorner",
    "currency": "GBP",
    "currency_symbol": "£"
  },
  "key": {
    "id": "ak_1f2e3d4c5b6a",
    "name": "Discord bot",
    "scopes": [
      "tts:read",
      "tts:control"
    ]
  }
}