- Game events API
Please read the overwolf.games.events documentation page to learn how to use Overwolf game events.
Note that TFT, TFT PBE and LOL share the same Game ID.
If you would like to know when the user is going to play TFT (hit the "Play" button), you can listen to the LoL Launcher lobby_info info-update, and check the queueID
. If it's 1090 or 1100 - it's TFT, or 1130, for "Hyperoll".
Sample Apps
Available Features
Game events status
It's highly recommended to communicate errors to your users. Check game event status here or easily verify event status directly from your app using our API.
Because LOL and TFT share the same GameID, when checking TFT game event status please use 21570 as the unique GameID for TFT and 215701 for TFT PBE.
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. |
---|---|---|---|---|
is_pbe | game_info | Boolean value if the player is playing in TFT or in TFT PBE mode | See notes | 205.0 |
is_pbe note
Data Example:
{"feature":"game_info","category":"game_info","key":"is_pbe","value":"true"}
live_client_data
Info Updates
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
active_player | live_client_data | In-game data received by the client. | See notes | 143.1 |
all_players | live_client_data | In-game data received by the client. | See notes | 143.1 |
events | live_client_data | In-game data received by the client. | See notes | 143.1 |
game_data | live_client_data | In-game data received by the client. | See notes | 143.1 |
active_player note
Data Example:
{
"info":{
"live_client_data":{
"active_player":"{"abilities":{"E":{"abilityLevel":5,"displayName":"Unspeakable Horror","id"
:"NocturneUnspeakableHorror"
,"rawDescription":"GeneratedTip_Spell_NocturneUnspeakableHorror_Description"
...
,"rawDisplayName":"GeneratedTip_Spell_NocturneUnspeakableHorror_DisplayName"}
{"id":5008,"rawDescriptio":"perk_tooltip_StatModAdaptive"},{"id":5002,"rawDescription":"perk_tooltip_StatModArmor"}]},"level":17,"summonerName":"Sh4rgaas"}"
}
},
"feature":"live_client_data"
}
all_players note
Data Example:
{
"info":{
"live_client_data":{
"all_players":"[{"championName":"Sett","isBot":false,"isDead":true,"items":
[{"canUse":false,"consumable":false,"count":1,"displayName":"Dead Man's Plate"
,"itemID":3742,"price":1100,"rawDescription":"game_item_description_3742","rawDisplayName":"game_item_displayname_3742","slot":0}
,{"canUse":false,"consumable":false,"count":1,"displayName":"Bramble Vest"
...
{"displayName":"Flash","rawDescription":"GeneratedTip_SummonerSpell_SummonerFlash_Description","rawDisplayName"
:"GeneratedTip_SummonerSpell_SummonerFlash_DisplayName"},"summonerSpellTwo":
{"displayName":"Ignite","rawDescription":"GeneratedTip_SummonerSpell_SummonerDot_Description"
,"rawDisplayName":"GeneratedTip_SummonerSpell_SummonerDot_DisplayName"}},"team":"CHAOS"}]"
}
},
"feature":"live_client_data"
}
events note
Data Example:
{
"info":{
"live_client_data":{
"events":"{"Events":[{"EventID":0,"EventName":"GameStart"
,"EventTime":0.041107501834630966},{"EventID":1,"EventName":"MinionsSpawning",
"EventTime":65.05073547363281},{"Assisters":
["CHOWCHOWTHEPAIN","CHAXILICIOUSLOL"],
...
"EventID":2,"EventName":"ChampionKill","EventTime":321.79498291015625,"KillerName":"Adoucissant",
"VictimName":"finite area"},{"Assisters":["finite area","Dilipa"],"EventID":101,"EventName":
"ChampionKill","EventTime":2256.623291015625,"KillerName":"St4ubwedel","VictimName":"CHOWCHOWTHEPAIN"}]}"
}
},
"feature":"live_client_data"
}
game_data note
Data Example:
{
"info":{
"live_client_data":{
"game_data":"{"gameMode":"CLASSIC","gameTime":2258.9697265625,"mapName":"Map11","mapNumber":11,"mapTerrain":"Mountain"}"
}
},
"feature":"live_client_data"
}
me
Info Updates
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
summoner_name | me | Summoner name of the local player | See notes | 133.0 |
xp | me | Current player level, xp points, and xp points left to reach the next level | See notes | 133.0 |
health | me | Current amount of health points of the player | See notes | 133.0 |
rank | me | Current standing of the player | See notes | 133.0 |
gold | me | Player's spare gold in hand | See notes | 133.0 |
summoner_name notes
Data example:
{"info":{"me":{"summoner_name":"PoSeIdOnPrOx1"}},"feature":"me"}
xp notes
Data example:
{"info":{"me":{"xp":"{"level":1,"current_xp":0,"xp_max":2}"}},"feature":"me"}
health notes
Data example:
{"info":{"me":{"health":"11"}},"feature":"me"}
rank notes
Data example:
{"info":{"me":{"rank":"2"}},"feature":"me"}
Meaning 1st place/8th place, etc.
("Index" rank data in the roster is not accurate in real-time - only once the local player had died or won).
gold notes
Data example:
{"info":{"me":{"gold":"1"}},"feature":"me"}
match_info
Info Updates
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
pseudo_match_id | match_info | Current match’s ID code | See notes | 133.0 |
battle_state | match_info | Boolean. Whether a battle is in progress | See notes | 133.0 |
match_state | match_info | Boolean. Whether a match is in progress | See notes | 133.0 |
round_type | match_info | PvE, PvP, Portal, Carousel or Augment as well as stage number | See notes | 133.0 |
round_outcome | match_info | Outcome of the previous round | See notes | 133.0 |
opponent | match_info | Names of your opponents | See notes | 133.0 |
game_mode | match_info | Whether the current game mode is TFT or default LoL | See notes | 133.0 |
local_player_damage | match_info | Amount of damage caused by your champions | See notes | 0.136 |
item_select | match_info | List of available items | See notes | 259.0 |
picked_item | match_info | The last item that the player picked | See notes | 259.0 |
pseudo_match_id notes
This is an internal Overwolf-generated code, not related to Riot Games.
Data example:
a4e8fc75-b35e-466f-976c-09f4ee633d95
battle_state notes
Data example:
{"info":{"match_info":{"battle_state":"{"in_progress":true}"}},"feature":"match_info"}
match_state notes
Returns 'True' when the match starts. Returns 'False' once the local player dies or wins the match.
Data example:
{"info":{"match_info":{"match_state":"{"in_progress":true}"}},"feature":"match_info"}
{"info":{"match_info":{"match_state":"{"in_progress":false}"}},"feature":"match_info"}
round_type notes
Data examples:
{"feature": "match_info", "category": "match_info", "key": "round_type", "data": "{\"stage\":\"1-1\",\"name\":\"PVP\",\"type\":\"Carousel\",\"native_name\":\"Encounter_Group\"}"}
{"feature": "match_info", "category": "match_info", "key": "round_type", "data": "{\"stage\":\"1-2\",\"name\":\"PVE\",\"type\":\"Minions_1\",\"native_name\":\"Intro1\"}"}
{"feature": "match_info", "category": "match_info", "key": "round_type", "data": "{\"stage\":\"2-1\",\"name\":\"PVP\",\"type\":\"Augment_1\",\"native_name\":\"Combat_Set6_Standard_AugmentEarly\"}"}
{"feature": "match_info", "category": "match_info", "key": "round_type", "data": "{\"stage\":\"3-3\",\"name\":\"PVP\",\"type\":\"PVP\",\"native_name\":\"Combat\"}"}
{"feature": "match_info", "category": "match_info", "key": "round_type", "data": "{\"stage\":\"3-4\",\"name\":\"Carousel\",\"type\":\"Carousel\",\"native_name\":\"Carousel\"}"}
round_outcome notes
Data example:
{"feature":"match_info","category":"match_info","key":"round_outcome","value":"{\"Sigma\":{\"outcome\":\"victory\",\"tag_line\":\"00001\"},\"littlemelony\":{\"outcome\":\"defeat\",\"tag_line\":\"EUW\"},\"dADo\":{\"outcome\":\"victory\",\"tag_line\":\"TnT\"},\"rares\":{\"outcome\":\"victory\",\"tag_line\":\"rare\"},\"Sen\":{\"outcome\":\"victory\",\"tag_line\":\"5426\"},\"JacksAtWork\":{\"outcome\":\"victory\",\"tag_line\":\"1119\"},\"TABS Aurora\":{\"outcome\":\"victory\",\"tag_line\":\"Cute\"},\"koala \":{\"outcome\":\"victory\",\"tag_line\":\"king\"}}"}
opponent notes
Data example:
{"feature":"match_info","category":"match_info","key":"opponent","value":"{\"name\":\"MrGEP\",\"tag_line\":\"EUW\"}"}
game_mode notes
By default - 'game_mode' will always return "lol" value unless TFT is played.
Data example:
{"info":{"match_info":{"game_mode":"tft"}},"feature":"match_info"}
{"info":{"match_info":{"game_mode":"lol"}},"feature":"match_info"}
local_player_damage notes
This also includes the star level of each champion (1, 2 and 3 stars), indicated as "level 1, 2 or 3".
Data Example:
{"info":{"match_info":{"local_player_damage":"{"unit_0":{"name":"TFT4_Warwick","damage":658,"level":1},"unit_1":{"name":"TFT4_Fiora","damage":593,"level":2},"unit_2":{"name":"TFT4_Shen","damage":545,"level":1},"unit_3":{"name":"TFT4_Jax","damage":2115,"level":3},"unit_4":{"name":"TFT4_Kalista","damage":2015,"level":2},"unit_5":{"name":"TFT4_Yasuo","damage":1558,"level":2},"unit_6":{"name":"TFT4_Irelia","damage":138,"level":2},"unit_7":{"name":"TFT4_Janna","damage":113,"level":2},"unit_8":{"name":"TFT4_Yone","damage":1074,"level":1}}"}},"feature":"match_info"}
item_select notes
Data example:
{"feature":"match_info","category":"match_info","key":"item_select","value":"{\"item_1\":{\"name\":\"TFT_Item_NeedlesslyLargeRod\"}, \"item_2\":{\"name\":\"TFT_Item_RecurveBow\"}, \"item_3\":{\"name\":\"TFT_Item_NegatronCloak\"}, \"item_4\":{\"name\":\"TFT_Item_BFSword\"}}"}
picked_item notes
Data example:
{"feature":"match_info","category":"match_info","key":"picked_item","value":"TFT_Item_NeedlesslyLargeRod"}
Events
Event | Event Data | Fired When | Notes | Since GEP Ver. |
---|---|---|---|---|
round_start | "PVE"/"PVP"/"carousel" | One round ends and another begins | See notes | 133.0 |
round_end | null | At the round's end | See notes | 133.0 |
battle_start | "PVP"/"PVE" | Start of the battle vs an opponent or AI | See notes | 133.0 |
battle_end | null | End of the battle vs an opponent or AI | See notes | 133.0 |
match_start | null | Beginning of a TFT match | See notes | 133.0 |
match_end | null | Ending of a TFT match | See notes | 133.0 |
round_start notes
Data example:
{"events":[{"name":"round_start","data":""}]}
round_end notes
Data example:
{"events":[{"name":"round_end","data":""}]}
battle_start notes
Data example:
{"events":[{"name":"battle_start","data":"PVE"}]}
battle_end notes
Data example:
{"events":[{"name":"battle_end","data":""}]}
match_start notes
Data example:
{"events":[{"name":"match_start","data":""}]}
match_end notes
Data example:
{"events":[{"name":"match_end","data":""}]}
roster
Info Updates
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
player_status | roster | Full list of players currently in the match | See notes | 133.0 |
roster/player_status notes
The full roster of players will first appear during the loading screen.
Each player object includes the following data:
- index
- health
- xp
- localplayer
- rank
- tag_line
Aside from the summoner name which is received during the loading screen, the rest of the data mentioned above will be delivered once the actual game has begun.
Important note regarding "index" data
The final & accurate rank position of each player in the match will be given only at the end of the match when the local player has died or won.
Data example:
{
"info": {
"roster": {
"player_status": "{
"Sigma": {
"index": 1,
"health": 76,
"xp": 5,
"localplayer": false,
"rank": 0,
"tag_line": 00001
},
"littlemelony": {
"index": 2,
"health": 94,
"xp": 4,
"localplayer": false,
"rank": 0,
"tag_line": EUW
},
"dADo": {
"index": 3,
"health": 88,
"xp": 6,
"localplayer": false,
"rank": 0,
"tag_line": TnT
},
"raresGUY": {
"index": 4,
"health": 62,
"xp": 6,
"localplayer": false,
"rank": 0,
"rare"
},
"Sen": {
"index": 5,
"health": 90,
"xp": 4,
"localplayer": false,
"rank": 0,
"tag_line": 5426
},
"JacksAtWork": {
"index": 6,
"health": 100,
"xp": 4,
"localplayer": true,
"rank": 0,
"tag_line": 1191
},
"TABS Aurora": {
"index": 7,
"health": 92,
"xp": 5,
"localplayer": false,
"rank": 0,
"tag_line": Cute
},
"koala": {
"index": 8,
"health": 0,
"xp": 5,
"localplayer": false,
"rank": 8,
"tag_line": king
},
}"
}
},
"feature": "roster"
}
store
Info Updates
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
shop_pieces | store | Available champions for purchase | See notes | 134.0 |
shop_pieces note
Once you purchase a champion, there will be a new update that indicates "Sold" for a purchased slot.
Data Example:
{
"info":{
"store":{
"shop_pieces":"{
"slot_1":{
"name":"TFT_Blitzcrank"
},
"slot_2":{
"name":"TFT_Garen"
},
"slot_3":{
"name":"TFT_Nidalee"
},
"slot_4":{
"name":"TFT_Mordekaiser"
},
"slot_5":{
"name":"TFT_Ahri"
}
}"
}
},
"feature":"store"
}
board
Info Updates
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
board_pieces | board | Exact position of each chess piece on the grid, including their current level and the items they possess | See notes | 134.0 |
board_pieces note
Data Example:
{
"info":{
"board":{
"board_pieces":"{
"cell_9":{
"name":"TFT_Tristana",
"level":"1",
"item_1":"TFT_Item_GuinsoosRageblade",
"item_2":"",
"item_3":""
},
"cell_16":{
"name":"TFT_KhaZix",
"level":"1",
"item_1":"",
"item_2":"",
"item_3":""
}
}"
}
},
"feature":"board"
}
bench
Info Updates
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
bench_pieces | bench | Exact position of each chess piece on the bench including their current level and items they possess (inventory) | See notes | 134.0 |
bench_pieces note
Data Example:
{
"info":{
"bench":{
"bench_pieces":"{" slot_1":{
"name":"TFT_Garen",
"level":"1",
"item_1":"",
"item_2":"",
"item_3":""
},
"slot_2":{
"name":"TFT_Darius",
"level":"2",
"item_1":"",
"item_2":"",
"item_3":""
},
"slot_3":{
"name":"TFT_Leona",
"level":"1",
"item_1":"",
"item_2":"",
"item_3":""
},
"slot_4":{
"name":"TFT_Sejuani",
"level":"1",
"item_1":"",
"item_2":"",
"item_3":""
},
"slot_5":{
"name":"TFT_Leona",
"level":"1",
"item_1":"",
"item_2":"",
"item_3":""
},
"slot_6":{
"name":"TFT_Kayle",
"level":"1",
"item_1":"TFT_Item_RapidFirecannon",
"item_2":"",
"item_3":""
},
"slot_9":{
"name":"TFT_MissFortune",
"level":"1",
"item_1":"",
"item_2":"",
"item_3":""
}
} "
}
},
" feature":"bench"
}
carousel
Info Updates
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
carousel_pieces | carousel | Names of available champions in the carousel | See notes | 134.0 |
carousel_pieces note
Data Example:
{
"info":{
"carousel":{
"carousel_pieces":"{
"slot_1":{
"name":"TFT_Morgana",
"item_1":"0"
},
"slot_2":{
"name":"TFT_Lissandra",
"item_1":"0"
},
"slot_3":{
"name":"TFT_Rengar",
"item_1":"0"
},
"slot_4":{
"name":"TFT_Veigar",
"item_1":"0"
},
"slot_5":{
"name":"TFT_Gangplank",
"item_1":"0"
},
"slot_6":{
"name":"TFT_Zed",
"item_1":"0"
},
"slot_7":{
"name":"TFT_Brand",
"item_1":"0"
},
"slot_8":{
"name":"TFT_Graves",
"item_1":"0"
},
"slot_9":{
"name":"TFT_Gnar",
"item_1":"0"
},
"slot_10":{
"name":"TFT_Chogath",
"item_1":"0"
}
} "}},"feature":"carousel"
}
augments
Info Updates
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
me | me | List of available augments | See notes | 197.1 |
picked_augment | me | The last augment that the player picked | See notes | 222.0 |
me note
Data Example:
{"feature":"augments","category":"me","key":"me","value":"{\"augment_1\":{\"name\":\"TFT8_Augment_DefenderTrait\"}, \"augment_2\":{\"name\":\"TFT7_Augment_PandorasBench\"}, \"augment_3\":{\"name\":\"TFT6_Augment_SecondWind1\"}, }"}
picked_augment note
Data Example:
{"info":{"me":{"picked_augment":"{\"slot_1\":{\"name\":\"TFT9_Augment_CyberneticBulk3\"}, \"slot_2\":{\"name\":\"TFT9_Augment_SettTheBoss\"}, \"slot_3\":{\"name\":\"\"}}"}},"feature":"augments"}