Overlays are public. You no longer need an API key or any overlay-specific permissions to use the Battles Overlay.Documentation Index
Fetch the complete documentation index at: https://teambattles.gg/docs/llms.txt
Use this file to discover all available pages before exploring further.
What Changed
Every widget in the overlay editor now fetches public, profile-keyed data:| Widget | Data scoped to |
|---|---|
| User Stats | Overlay owner’s profile |
| Team Stats | Selected team (must be public) |
| Organization Stats | Selected org (must be public) |
| Active Match | Overlay owner’s profile |
| Leaderboard Rank | Overlay owner’s profile |
| Top 3 Players | Global (public leaderboard) |
| Referral Code | Overlay owner’s profile |
| Game Rank | Overlay owner’s profile |
Profile Visibility
User-scoped widgets (user stats, user rank, active match, referral, game rank) require the overlay owner’sprofileVisibility to be public or limited. If the profile is private, those widgets will not render.
Team and organization widgets require the team’s profileVisibility === "public" or the org’s isPublic === true respectively.