Skip to main content
Each overlay widget requires specific API key scopes to access data. This page explains which permissions you need and how to configure them.

​
Required Scopes by Widget

WidgetRequired ScopeAccess Level
User Statsstats.user_statsRead
Team Statsstats.team_statsRead
Organization Statsstats.org_statsRead
Active Matchmatches.user_matchesRead
Leaderboard Rankleaderboard.user_rankRead
Top 3 Playersleaderboard.top_playersRead
Referral Codestats.user_statsRead
Game Rankgame.game_rankRead

​
Using the Battles Overlay Preset

The easiest way to set up permissions is to use the Battles Overlay preset when creating your API key. This automatically selects all scopes needed for every widget.
1

Go to Developer Settings

Navigate to Settings > Developer
2

Click Create API Key

Enter a label like “Stream Overlay”
3

Select the Battles Overlay preset

Click Battles Overlay in the preset selector. All required scopes are enabled automatically.
4

Copy and save your key

Copy the generated key immediately and save it somewhere secure (e.g., a password manager or a private note). The full key is shown only once and cannot be retrieved later. You will need it to complete your overlay URL.
The Battles Overlay preset is the recommended approach. It ensures all widgets work without needing to manage individual scopes.

​
Updating Permissions on an Existing Key

If you already have an API key and need to add overlay permissions:
1

Go to Developer Settings

Navigate to Settings > Developer
2

Find your key

Locate the API key you want to update in the list
3

Edit permissions

Click the key to expand it, then enable the scopes you need from the table above
4

Save changes

Click Save to apply the updated permissions

​
What Happens When Permissions Are Missing

If your API key is missing a required scope for a widget:
  • The widget toggle in the editor will be grayed out
  • A scope warning will appear next to the widget name, indicating which permission is missing
  • The widget will not render in the overlay output
You can still use the overlay with partial permissions. Only the widgets that have all required scopes will be available.
Grayed-out widgets do not affect the rest of your overlay. Enable only the scopes you need for the widgets you want to use.