Loading...

Game events API

Please read the overwolf.games.events documentation page to learn how to use Overwolf game events.

Sample Apps

• Roblox game events sample app

Available Features

• gep_internal
• game_info
• match_info

Game events status

It's highly recommended to communicate errors and warnings to your app users. Check current game event status here or easily check game event status from your app using our API.

gep_internal

Info Updates

key	Category	Values	Notes	Since GEP Ver.
gep_internal	gep_internal	Local + Public version number	See notes	143.0

gep_internal note

Data Example:

{"info":{"gep_internal":{"version_info":"{"local_version":"157.0.1","public_version":"157.0.1","is_updated":true}"}},"feature":"gep_internal"}

game_info

Info Updates

key	Category	Values	Notes	Since GEP Ver.
user_id	game_info	The local player user ID.	See notes	257.0

user_id note

Data Example:

{"feature":"game_info","category":"game_info","key":"user_id","value":"9193"}

tip

Roblox provides public APIs to retrieve detailed user, group, avatar, and badge information.

---

1. Get User Information

Use this endpoint to fetch detailed data about a specific Roblox user:
https://users.roblox.com/v1/users/{user_id}
Replace {user_id} with the actual Roblox user ID.

Example: https://users.roblox.com/v1/users/9193

This endpoint returns details such as:

• Username and display name
• User description
• Account creation date
• Banned status and ID

---

2. Get User Group Roles

Use this endpoint to retrieve the groups a user belongs to, along with their roles within each group:
https://groups.roblox.com/v1/users/{user_id}/groups/roles
Replace {user_id} with the target user’s ID.

Example: https://groups.roblox.com/v1/users/317/groups/roles

This endpoint returns details such as:

• Group ID and name
• User’s role and rank within each group
• Whether the user owns the group

---

3. Get User Avatar (Full Avatar Data)

Use this endpoint to retrieve the user’s avatar configuration, including all assets and body colors:
https://avatar.roblox.com/v1/users/{user_id}/avatar
Replace {user_id} with the user’s ID.

Example: https://avatar.roblox.com/v1/users/9193/avatar

This endpoint returns details such as:

• Avatar type (R6 or R15)
• Equipped items (hats, faces, packages, etc.)
• Body color IDs
• Scaling and avatar height

---

4. Get User Avatar Headshot Thumbnail

Use this endpoint to retrieve a user’s avatar thumbnail or profile image:
https://thumbnails.roblox.com/v1/users/avatar-headshot?userIds={user_id}&size={size}&format={format}&isCircular={bool}
Replace parameters as follows:

• {user_id} - Roblox user ID
• {size} - e.g., 150x150, 420x420
• {format} - Png or Jpeg
• {bool} - true or false for circular images

Example:
https://thumbnails.roblox.com/v1/users/avatar-headshot?userIds=9193&size=150x150&format=Png&isCircular=false

This endpoint returns a URL to the user’s avatar image.

---

5. Get User Badges

Use this endpoint to retrieve a list of badges a user has earned:
https://badges.roblox.com/v1/users/{user_id}/badges?limit={limit}&sortOrder={order}
Replace {user_id} with the user’s ID, {limit} with the number of badges to retrieve, and {order} with Asc or Desc.

Example:
https://badges.roblox.com/v1/users/9193/badges?limit=10&sortOrder=Asc

This endpoint returns details such as:

• Badge name and description
• Awarding experience (game) ID
• Creation and awarding timestamps

---

6. Get Roblox-Granted Badges

Use this endpoint to retrieve official Roblox badges granted directly by Roblox (e.g., "Administrator", "Veteran", "Welcome to the Club"):
https://accountinformation.roblox.com/v1/users/{user_id}/roblox-badges
Replace {user_id} with the user’s ID.

Example: https://accountinformation.roblox.com/v1/users/9193/roblox-badges

This endpoint returns details such as:

• Official Roblox badge names
• Descriptions
• Badge icons

---

How These APIs Work Together

You can use these endpoints to build a complete user profile:

1. Start with User Info to get basic details.
2. Fetch Group Roles for community affiliations.
3. Retrieve Avatar Data and Headshot Thumbnail for visual representation.
4. List User Badges and Roblox Badges for achievements and status.

Together, they provide a full view of a Roblox user’s identity, avatar, affiliations, and accomplishments - perfect for analytics, user dashboards, or game integrations.

match_info

Info Updates

key	Category	Values	Notes	Since GEP Ver.
game_id	game_info	The current played minigame ID.	See notes	257.0
universe_id	match_info	The current played universe ID.	See notes	258.0

game_id note

Data Example:

{"feature":"match_info","category":"match_info","key":"game_id","value":"15744137588"}

universe_id note

Data Example:

{"feature":"match_info","category":"match_info","key":"universe_id","value":"3164075108"}

tip

Roblox provides a set of connected APIs to retrieve detailed game, place, and thumbnail information.

---

1. Get Game Information (by Universe ID)

Use this endpoint to fetch metadata about a Roblox game:
https://games.roblox.com/v1/games?universeIds={universe_id}
Replace {universe_id} with one or more universe IDs (comma-separated).

Example: https://games.roblox.com/v1/games?universeIds=3164075108

This endpoint returns details such as:

• Game name and description
• Creator information
• Player counts (current and all-time)
• Genre and root place ID

---

2. Get Place Details (using Place ID)

Use the root place ID (returned from the endpoint above) to retrieve detailed information about a specific place within the game:
https://games.roblox.com/v1/games/multiget-place-details?placeIds={place_id}
Replace {place_id} with one or more place IDs (comma-separated).

Example: https://games.roblox.com/v1/games/multiget-place-details?placeIds=8246874626

This endpoint returns details such as:

• Place name and description
• Game universe ID
• Creator information
• Maximum player count and supported gear types

---

3. Get Game Thumbnail (Icon)

Use this endpoint to retrieve the thumbnail (icon) associated with a specific game universe:
https://thumbnails.roblox.com/v1/games/icons?universeIds={universe_id}&size={size}&format={format}&isCircular={bool}
Replace parameters as follows:

• {universe_id} - one or more universe IDs (comma-separated)
• {size} - thumbnail size (e.g., 150x150, 256x256)
• {format} - image format (Png or Jpeg)
• {bool} - whether the image should be circular (true or false)

Example:
https://thumbnails.roblox.com/v1/games/icons?universeIds=3164075108&size=150x150&format=Png&isCircular=false

This endpoint returns a direct link to the game’s icon or thumbnail image.

---

Together, these endpoints provide a complete overview of a Roblox game, including its metadata, structure, and visual identity ideal for use in analytics, dashboards, or game discovery tools.

Events

Event	Event Data	Fired When	Notes	Since GEP Ver.
match_start	null	Round starts	See notes	257.0
match_end	null	Round ends	See notes	257.0
record_start	null	Record starts	See notes	257.0
record_end	null	Record ends	See notes	257.0

match_start note

Data Example:

{"events":[{"name":"match_start","data":""}]}

match_end note

Data Example:

{"events":[{"name":"match_end","data":""}]}

record_start note

Data Example:

{"events":[{"name":"record_start","data":""}]}

record_end note

Data Example:

{"events":[{"name":"record_end","data":""}]}

Events status

Loading...