| Surface | Best for | Auth |
|---|---|---|
| Platform API | Live playback, now playing, in-progress state, and app integrations | Bearer token via app-bound device flow |
| Public API | Public profile embeds, dashboards, bots, and companion widgets | No auth |
What you can build
- Second-screen apps that stay in sync with what a user is watching
- Companion mobile apps with now-playing and continue-watching state
- Desktop or TV integrations that report playback lifecycle events
- Public profile widgets, community dashboards, and analytics overlays
Current platform capabilities
- Developer app registration at
https://punchplay.tv/developers - Confidential and public client types
- App-bound device authentication
- Versioned platform endpoints under
/api/platform/v1 - Scope-aware platform tokens
- Playback writes for
start,pause,resume,stop, andprogress - Live playback state via now-playing, in-progress, and SSE updates
- Read-only public user data under
/api/public/v1
Start here
Quickstart
Register an app, authenticate a user, and send your first playback event in minutes.
Authentication
Implement the device flow: scopes, token lifecycle, and security guidance.
Playback API
Send start, pause, resume, stop, and progress events from your integration.
Public API
No-auth read-only access to public profiles — no credentials required.
Stability and versioning
All public developer endpoints are versioned. The current contract isv1.
- Stable platform endpoints live under
/api/platform/v1 - Stable public endpoints live under
/api/public/v1 - Breaking changes will ship in a new versioned namespace