Skip to content
TipPage Docs
Esc
navigateopen⌘Jpreview
On this page

Overview

TipPage's developer API - API keys, the REST endpoints, signed webhooks, and a live event stream.

TipPage has a full developer API: read your tips, drive the TTS and media queues, and get events pushed to your own server the moment they happen. People use it for Discord bots, smart lights that react to tips, VOD archivers, Stream Deck controls, and custom overlays - if you can code it, you can wire it to your TipPage.

This tab is the whole thing:

  • Authentication - API keys and the scopes they carry.
  • OAuth 2.0 - a Connect button for apps other streamers use; tokens work exactly like keys.
  • Webhooks - signed events POSTed to your server, and how to verify them.
  • Realtime WebSocket - the same events, live over a socket, no endpoint to host.
  • Claim, do your thing, finish - the pattern that makes the API special: being the thing that plays tips.
  • Guides - the chat bot loop, viewer credits, AI voices, and a worked example.
  • Reference - every endpoint, one page each, with schemas and code samples.

The whole API is also described by one OpenAPI 3.1 document: download openapi.yaml - import it into Postman, Insomnia, or Bruno, or feed it to a client generator.

URLs

API base https://api.tippage.com/v1
Webhooks you host the endpoint; TipPage POSTs to it (see Webhooks)
Realtime stream wss://ws.tippage.com (see Realtime WebSocket)

Rate limits

240 requests/min per IP and 120 requests/min per key, reported in standard RateLimit-* response headers. Exceeding a limit returns 429. Chat sends (POST /v1/chat/messages) have their own budget on top: 20 messages per 30 seconds per streamer, shared across every key on the account.

Was this page helpful?