Documentation

This site documents the current tipply-sdk-ts API surface. It is an unofficial project and is not affiliated with Tipply.

Use this SDK when you need typed access to authenticated Tipply endpoints, public goal and voting widgets, or realtime TIP_ALERT events from Bun, Node.js, or the browser.

What You Will Find Here

• installation and first-request setup
• authenticated and public client guides
• realtime TIP_ALERT connection patterns
• transport, validation, and error handling details
• API reference split into focused pages instead of one long list

Documentation Map

• Start with Overview for the shortest path to a working client.
• Read Authentication if you need private endpoints.
• Use Authenticated Client or Public Client depending on the data you need.
• Keep Client Surface and the resource reference pages open while integrating.

Main Capabilities

• authenticated resources such as me, dashboard, profile, settings, tips, withdrawals, and reports
• public resources such as goal widgets, voting configuration, template fonts, and widget message flags
• realtime listeners for TIP_ALERT
• typed ID helpers such as asUserId() and asTipId()

Next Steps

1. Open Overview.
2. Pick Authenticated Client or Public Client.
3. Use the Reference section when wiring the full integration.