- Game events API
Please read the overwolf.games.events documentation page to learn how to use Overwolf game events.
Note that you can also use the LOL game launcher events. Read more here.
Sample Apps
Available Features
- gep_internal
- live_client_data
- matchState
- match_info
- death
- respawn
- abilities
- kill
- assist
- gold
- minions
- summoner_info
- gameMode
- teams
- level
- announcer
- counters
- damage
- heal
- jungle_camps
- team_frames
- chat
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"}
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 |
port | live_client_data | In-game data received by the client. | See notes | 155.0 |
active_player note
Click to see some data example
{
"info": {
"live_client_data": {
"active_player": {
"abilities": {
"E": {
"abilityLevel": 0,
"displayName": "Stacked Deck",
"id": "CardmasterStack",
"rawDescription": "GeneratedTip_Spell_CardmasterStack_Description",
"rawDisplayName": "GeneratedTip_Spell_CardmasterStack_DisplayName"
},
"Passive": {
"displayName": "Loaded Dice",
"id": "SecondSight",
"rawDescription": "GeneratedTip_Passive_SecondSight_Description",
"rawDisplayName": "GeneratedTip_Passive_SecondSight_DisplayName"
},
"Q": {
"abilityLevel": 0,
"displayName": "Wild Cards",
"id": "WildCards",
"rawDescription": "GeneratedTip_Spell_WildCards_Description",
"rawDisplayName": "GeneratedTip_Spell_WildCards_DisplayName"
},
"R": {
"abilityLevel": 0,
"displayName": "Destiny",
"id": "Destiny",
"rawDescription": "GeneratedTip_Spell_Destiny_Description",
"rawDisplayName": "GeneratedTip_Spell_Destiny_DisplayName"
},
"W": {
"abilityLevel": 0,
"displayName": "Pick a Card",
"id": "PickACard",
"rawDescription": "GeneratedTip_Spell_PickACard_Description",
"rawDisplayName": "GeneratedTip_Spell_PickACard_DisplayName"
}
},
"championStats": {
"abilityHaste": 0,
"abilityPower": 0,
"armor": 21,
"armorPenetrationFlat": 0,
"armorPenetrationPercent": 1,
"attackDamage": 25,
"attackRange": 0,
"attackSpeed": 0.6510000228881836,
"bonusArmorPenetrationPercent": 1,
"bonusMagicPenetrationPercent": 1,
"cooldownReduction": 0,
"critChance": 0,
"critDamage": 0,
"currentHealth": 534,
"healthRegenRate": 0,
"lifeSteal": 0,
"magicLethality": 0,
"magicPenetrationFlat": 0,
"magicPenetrationPercent": 1,
"magicResist": 30,
"maxHealth": 534,
"moveSpeed": 330,
"physicalLethality": 0,
"resourceMax": 333,
"resourceRegenRate": 0,
"resourceType": "MANA",
"resourceValue": 333,
"spellVamp": 0,
"tenacity": 0
},
"currentGold": 0,
"fullRunes": {
"generalRunes": [
{
"displayName": "Dark Harvest",
"id": 8128,
"rawDescription": "perk_tooltip_DarkHarvest",
"rawDisplayName": "perk_displayname_DarkHarvest"
},
{
"displayName": "Taste of Blood",
"id": 8139,
"rawDescription": "perk_tooltip_TasteOfBlood",
"rawDisplayName": "perk_displayname_TasteOfBlood"
},
{
"displayName": "Eyeball Collection",
"id": 8138,
"rawDescription": "perk_tooltip_EyeballCollection",
"rawDisplayName": "perk_displayname_EyeballCollection"
},
{
"displayName": "Ravenous Hunter",
"id": 8135,
"rawDescription": "perk_tooltip_RavenousHunter",
"rawDisplayName": "perk_displayname_RavenousHunter"
},
{
"displayName": "Presence of Mind",
"id": 8009,
"rawDescription": "perk_tooltip_PresenceOfMind",
"rawDisplayName": "perk_displayname_PresenceOfMind"
},
{
"displayName": "Coup de Grace",
"id": 8014,
"rawDescription": "perk_tooltip_CoupDeGrace",
"rawDisplayName": "perk_displayname_CoupDeGrace"
}
],
"keystone": {
"displayName": "Dark Harvest",
"id": 8128,
"rawDescription": "perk_tooltip_DarkHarvest",
"rawDisplayName": "perk_displayname_DarkHarvest"
},
"primaryRuneTree": {
"displayName": "Domination",
"id": 8100,
"rawDescription": "perkstyle_tooltip_7200",
"rawDisplayName": "perkstyle_displayname_7200"
},
"secondaryRuneTree": {
"displayName": "Precision",
"id": 8000,
"rawDescription": "perkstyle_tooltip_7201",
"rawDisplayName": "perkstyle_displayname_7201"
},
"statRunes": [
{ "id": 5008, "rawDescription": "perk_tooltip_StatModAdaptive" },
{ "id": 5008, "rawDescription": "perk_tooltip_StatModAdaptive" },
{ "id": 5003, "rawDescription": "perk_tooltip_StatModMagicResist" }
]
},
"level": 1,
"summonerName": "Sh4rgaas"
}
}
},
"feature": "live_client_data"
}
all_players note
Click to see some data example
{
"info": {
"live_client_data": {
"all_players": [
{
"championName": "Twisted Fate",
"isBot": false,
"isDead": false,
"items": [
{
"canUse": true,
"consumable": true,
"count": 1,
"displayName": "Poro - Snax",
"itemID": 2052,
"price": 0,
"rawDescription": "game_item_description_2052",
"rawDisplayName": "game_item_displayname_2052",
"slot": 6
}
],
"level": 1,
"position": "NONE",
"rawChampionName": "game_character_displayname_TwistedFate",
"rawSkinName": "game_character_skin_displayname_TwistedFate_9",
"respawnTimer": 0,
"runes": {
"keystone": {
"displayName": "Dark Harvest",
"id": 8128,
"rawDescription": "perk_tooltip_DarkHarvest",
"rawDisplayName": "perk_displayname_DarkHarvest"
},
"primaryRuneTree": {
"displayName": "Domination",
"id": 8100,
"rawDescription": "perkstyle_tooltip_7200",
"rawDisplayName": "perkstyle_displayname_7200"
},
"secondaryRuneTree": {
"displayName": "Precision",
"id": 8000,
"rawDescription": "perkstyle_tooltip_7201",
"rawDisplayName": "perkstyle_displayname_7201"
}
},
"scores": {
"assists": 0,
"creepScore": 0,
"deaths": 0,
"kills": 0,
"wardScore": 0
},
"skinID": 9,
"skinName": "Cutpurse Twisted Fate",
"summonerName": "Sh4rgaas",
"summonerSpells": {
"summonerSpellOne": {
"displayName": "Ghost",
"rawDescription": "GeneratedTip_SummonerSpell_SummonerHaste_Description",
"rawDisplayName": "GeneratedTip_SummonerSpell_SummonerHaste_DisplayName"
},
"summonerSpellTwo": {
"displayName": "Flash",
"rawDescription": "GeneratedTip_SummonerSpell_SummonerFlash_Description",
"rawDisplayName": "GeneratedTip_SummonerSpell_SummonerFlash_DisplayName"
}
},
"team": "CHAOS"
},
{
"championName": "Brand",
"isBot": false,
"isDead": false,
"items": [],
"level": 1,
"position": "NONE",
"rawChampionName": "game_character_displayname_Brand",
"rawSkinName": "game_character_skin_displayname_Brand_2",
"respawnTimer": 0,
"runes": {
"keystone": {
"displayName": "Dark Harvest",
"id": 8128,
"rawDescription": "perk_tooltip_DarkHarvest",
"rawDisplayName": "perk_displayname_DarkHarvest"
},
"primaryRuneTree": {
"displayName": "Domination",
"id": 8100,
"rawDescription": "perkstyle_tooltip_7200",
"rawDisplayName": "perkstyle_displayname_7200"
},
"secondaryRuneTree": {
"displayName": "Precision",
"id": 8000,
"rawDescription": "perkstyle_tooltip_7201",
"rawDisplayName": "perkstyle_displayname_7201"
}
},
"scores": {
"assists": 0,
"creepScore": 0,
"deaths": 0,
"kills": 0,
"wardScore": 0
},
"skinID": 2,
"skinName": "Vandal Brand",
"summonerName": "Gordon xD",
"summonerSpells": {
"summonerSpellOne": {
"displayName": "Flash",
"rawDescription": "GeneratedTip_SummonerSpell_SummonerFlash_Description",
"rawDisplayName": "GeneratedTip_SummonerSpell_SummonerFlash_DisplayName"
},
"summonerSpellTwo": {
"displayName": "Heal",
"rawDescription": "GeneratedTip_SummonerSpell_SummonerHeal_Description",
"rawDisplayName": "GeneratedTip_SummonerSpell_SummonerHeal_DisplayName"
}
},
"team": "ORDER"
},
{
"championName": "Gragas",
"isBot": false,
"isDead": false,
"items": [],
"level": 1,
"position": "NONE",
"rawChampionName": "game_character_displayname_Gragas",
"rawSkinName": "game_character_skin_displayname_Gragas_10",
"respawnTimer": 0,
"runes": {
"keystone": {
"displayName": "Dark Harvest",
"id": 8128,
"rawDescription": "perk_tooltip_DarkHarvest",
"rawDisplayName": "perk_displayname_DarkHarvest"
},
"primaryRuneTree": {
"displayName": "Domination",
"id": 8100,
"rawDescription": "perkstyle_tooltip_7200",
"rawDisplayName": "perkstyle_displayname_7200"
},
"secondaryRuneTree": {
"displayName": "Precision",
"id": 8000,
"rawDescription": "perkstyle_tooltip_7201",
"rawDisplayName": "perkstyle_displayname_7201"
}
},
"scores": {
"assists": 0,
"creepScore": 0,
"deaths": 0,
"kills": 0,
"wardScore": 0
},
"skinID": 10,
"skinName": "Arctic Ops Gragas",
"summonerName": "IM Piotrovic",
"summonerSpells": {
"summonerSpellOne": {
"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": "ORDER"
},
{
"championName": "Shen",
"isBot": false,
"isDead": false,
"items": [],
"level": 1,
"position": "NONE",
"rawChampionName": "game_character_displayname_Shen",
"rawSkinName": "game_character_skin_displayname_Shen_6",
"respawnTimer": 0,
"runes": {
"keystone": {
"displayName": "Hail of Blades",
"id": 9923,
"rawDescription": "perk_tooltip_HailOfBlades",
"rawDisplayName": "perk_displayname_HailOfBlades"
},
"primaryRuneTree": {
"displayName": "Domination",
"id": 8100,
"rawDescription": "perkstyle_tooltip_7200",
"rawDisplayName": "perkstyle_displayname_7200"
},
"secondaryRuneTree": {
"displayName": "Precision",
"id": 8000,
"rawDescription": "perkstyle_tooltip_7201",
"rawDisplayName": "perkstyle_displayname_7201"
}
},
"scores": {
"assists": 0,
"creepScore": 0,
"deaths": 0,
"kills": 0,
"wardScore": 0
},
"skinID": 6,
"skinName": "TPA Shen",
"summonerName": "ToxicMolester",
"summonerSpells": {
"summonerSpellOne": {
"displayName": "Clarity",
"rawDescription": "GeneratedTip_SummonerSpell_SummonerMana_Description",
"rawDisplayName": "GeneratedTip_SummonerSpell_SummonerMana_DisplayName"
},
"summonerSpellTwo": {
"displayName": "Flash",
"rawDescription": "GeneratedTip_SummonerSpell_SummonerFlash_Description",
"rawDisplayName": "GeneratedTip_SummonerSpell_SummonerFlash_DisplayName"
}
},
"team": "ORDER"
},
{
"championName": "Vayne",
"isBot": false,
"isDead": false,
"items": [],
"level": 1,
"position": "NONE",
"rawChampionName": "game_character_displayname_Vayne",
"respawnTimer": 0,
"runes": {
"keystone": {
"displayName": "Hail of Blades",
"id": 9923,
"rawDescription": "perk_tooltip_HailOfBlades",
"rawDisplayName": "perk_displayname_HailOfBlades"
},
"primaryRuneTree": {
"displayName": "Domination",
"id": 8100,
"rawDescription": "perkstyle_tooltip_7200",
"rawDisplayName": "perkstyle_displayname_7200"
},
"secondaryRuneTree": {
"displayName": "Precision",
"id": 8000,
"rawDescription": "perkstyle_tooltip_7201",
"rawDisplayName": "perkstyle_displayname_7201"
}
},
"scores": {
"assists": 0,
"creepScore": 0,
"deaths": 0,
"kills": 0,
"wardScore": 0
},
"skinID": 0,
"summonerName": "ToxikBull",
"summonerSpells": {
"summonerSpellOne": {
"displayName": "Flash",
"rawDescription": "GeneratedTip_SummonerSpell_SummonerFlash_Description",
"rawDisplayName": "GeneratedTip_SummonerSpell_SummonerFlash_DisplayName"
},
"summonerSpellTwo": {
"displayName": "Barrier",
"rawDescription": "GeneratedTip_SummonerSpell_SummonerBarrier_Description",
"rawDisplayName": "GeneratedTip_SummonerSpell_SummonerBarrier_DisplayName"
}
},
"team": "ORDER"
},
{
"championName": "Pantheon",
"isBot": false,
"isDead": false,
"items": [],
"level": 1,
"position": "NONE",
"rawChampionName": "game_character_displayname_Pantheon",
"respawnTimer": 0,
"runes": {
"keystone": {
"displayName": "Electrocute",
"id": 8112,
"rawDescription": "perk_tooltip_Electrocute",
"rawDisplayName": "perk_displayname_Electrocute"
},
"primaryRuneTree": {
"displayName": "Domination",
"id": 8100,
"rawDescription": "perkstyle_tooltip_7200",
"rawDisplayName": "perkstyle_displayname_7200"
},
"secondaryRuneTree": {
"displayName": "Precision",
"id": 8000,
"rawDescription": "perkstyle_tooltip_7201",
"rawDisplayName": "perkstyle_displayname_7201"
}
},
"scores": {
"assists": 0,
"creepScore": 0,
"deaths": 0,
"kills": 0,
"wardScore": 0
},
"skinID": 0,
"summonerName": "Haorn",
"summonerSpells": {
"summonerSpellOne": {
"displayName": "Flash",
"rawDescription": "GeneratedTip_SummonerSpell_SummonerFlash_Description",
"rawDisplayName": "GeneratedTip_SummonerSpell_SummonerFlash_DisplayName"
},
"summonerSpellTwo": {
"displayName": "Mark",
"rawDescription": "GeneratedTip_SummonerSpell_SummonerSnowball_Description",
"rawDisplayName": "GeneratedTip_SummonerSpell_SummonerSnowball_DisplayName"
}
},
"team": "ORDER"
},
{
"championName": "Rell",
"isBot": false,
"isDead": false,
"items": [],
"level": 1,
"position": "NONE",
"rawChampionName": "game_character_displayname_Rell",
"respawnTimer": 0,
"runes": {
"keystone": {
"displayName": "Aftershock",
"id": 8439,
"rawDescription": "perk_tooltip_VeteranAftershock",
"rawDisplayName": "perk_displayname_VeteranAftershock"
},
"primaryRuneTree": {
"displayName": "Resolve",
"id": 8400,
"rawDescription": "perkstyle_tooltip_7204",
"rawDisplayName": "perkstyle_displayname_7204"
},
"secondaryRuneTree": {
"displayName": "Precision",
"id": 8000,
"rawDescription": "perkstyle_tooltip_7201",
"rawDisplayName": "perkstyle_displayname_7201"
}
},
"scores": {
"assists": 0,
"creepScore": 0,
"deaths": 0,
"kills": 0,
"wardScore": 0
},
"skinID": 0,
"summonerName": "Tαkumi Usui",
"summonerSpells": {
"summonerSpellOne": {
"displayName": "Flash",
"rawDescription": "GeneratedTip_SummonerSpell_SummonerFlash_Description",
"rawDisplayName": "GeneratedTip_SummonerSpell_SummonerFlash_DisplayName"
},
"summonerSpellTwo": {
"displayName": "Mark",
"rawDescription": "GeneratedTip_SummonerSpell_SummonerSnowball_Description",
"rawDisplayName": "GeneratedTip_SummonerSpell_SummonerSnowball_DisplayName"
}
},
"team": "CHAOS"
},
{
"championName": "Anivia",
"isBot": false,
"isDead": false,
"items": [],
"level": 1,
"position": "NONE",
"rawChampionName": "game_character_displayname_Anivia",
"rawSkinName": "game_character_skin_displayname_Anivia_8",
"respawnTimer": 0,
"runes": {
"keystone": {
"displayName": "Dark Harvest",
"id": 8128,
"rawDescription": "perk_tooltip_DarkHarvest",
"rawDisplayName": "perk_displayname_DarkHarvest"
},
"primaryRuneTree": {
"displayName": "Domination",
"id": 8100,
"rawDescription": "perkstyle_tooltip_7200",
"rawDisplayName": "perkstyle_displayname_7200"
},
"secondaryRuneTree": {
"displayName": "Sorcery",
"id": 8200,
"rawDescription": "perkstyle_tooltip_7202",
"rawDisplayName": "perkstyle_displayname_7202"
}
},
"scores": {
"assists": 0,
"creepScore": 0,
"deaths": 0,
"kills": 0,
"wardScore": 0
},
"skinID": 8,
"skinName": "Papercraft Anivia",
"summonerName": "TheShackledCaps",
"summonerSpells": {
"summonerSpellOne": {
"displayName": "Flash",
"rawDescription": "GeneratedTip_SummonerSpell_SummonerFlash_Description",
"rawDisplayName": "GeneratedTip_SummonerSpell_SummonerFlash_DisplayName"
},
"summonerSpellTwo": {
"displayName": "Barrier",
"rawDescription": "GeneratedTip_SummonerSpell_SummonerBarrier_Description",
"rawDisplayName": "GeneratedTip_SummonerSpell_SummonerBarrier_DisplayName"
}
},
"team": "CHAOS"
},
{
"championName": "Jhin",
"isBot": false,
"isDead": false,
"items": [],
"level": 1,
"position": "NONE",
"rawChampionName": "game_character_displayname_Jhin",
"rawSkinName": "game_character_skin_displayname_Jhin_3",
"respawnTimer": 0,
"runes": {
"keystone": {
"displayName": "Dark Harvest",
"id": 8128,
"rawDescription": "perk_tooltip_DarkHarvest",
"rawDisplayName": "perk_displayname_DarkHarvest"
},
"primaryRuneTree": {
"displayName": "Domination",
"id": 8100,
"rawDescription": "perkstyle_tooltip_7200",
"rawDisplayName": "perkstyle_displayname_7200"
},
"secondaryRuneTree": {
"displayName": "Precision",
"id": 8000,
"rawDescription": "perkstyle_tooltip_7201",
"rawDisplayName": "perkstyle_displayname_7201"
}
},
"scores": {
"assists": 0,
"creepScore": 0,
"deaths": 0,
"kills": 0,
"wardScore": 0
},
"skinID": 3,
"skinName": "SKT T1 Jhin",
"summonerName": "SzczodryMarynarz",
"summonerSpells": {
"summonerSpellOne": {
"displayName": "Flash",
"rawDescription": "GeneratedTip_SummonerSpell_SummonerFlash_Description",
"rawDisplayName": "GeneratedTip_SummonerSpell_SummonerFlash_DisplayName"
},
"summonerSpellTwo": {
"displayName": "Barrier",
"rawDescription": "GeneratedTip_SummonerSpell_SummonerBarrier_Description",
"rawDisplayName": "GeneratedTip_SummonerSpell_SummonerBarrier_DisplayName"
}
},
"team": "CHAOS"
},
{
"championName": "Lissandra",
"isBot": false,
"isDead": false,
"items": [],
"level": 1,
"position": "NONE",
"rawChampionName": "game_character_displayname_Lissandra",
"rawSkinName": "game_character_skin_displayname_Lissandra_3",
"respawnTimer": 0,
"runes": {
"keystone": {
"displayName": "Electrocute",
"id": 8112,
"rawDescription": "perk_tooltip_Electrocute",
"rawDisplayName": "perk_displayname_Electrocute"
},
"primaryRuneTree": {
"displayName": "Domination",
"id": 8100,
"rawDescription": "perkstyle_tooltip_7200",
"rawDisplayName": "perkstyle_displayname_7200"
},
"secondaryRuneTree": {
"displayName": "Sorcery",
"id": 8200,
"rawDescription": "perkstyle_tooltip_7202",
"rawDisplayName": "perkstyle_displayname_7202"
}
},
"scores": {
"assists": 0,
"creepScore": 0,
"deaths": 0,
"kills": 0,
"wardScore": 0
},
"skinID": 3,
"skinName": "Program Lissandra",
"summonerName": "JALLLAA",
"summonerSpells": {
"summonerSpellOne": {
"displayName": "Mark",
"rawDescription": "GeneratedTip_SummonerSpell_SummonerSnowball_Description",
"rawDisplayName": "GeneratedTip_SummonerSpell_SummonerSnowball_DisplayName"
},
"summonerSpellTwo": {
"displayName": "Flash",
"rawDescription": "GeneratedTip_SummonerSpell_SummonerFlash_Description",
"rawDisplayName": "GeneratedTip_SummonerSpell_SummonerFlash_DisplayName"
}
},
"team": "CHAOS"
}
]
}
},
"feature": "live_client_data"
}
events note
Data Example:
{"info":{"live_client_data":{"events":"{"Events":[{"EventID":0,"EventName":"GameStart","EventTime":0.0417339988052845}]}"}},"feature":"live_client_data"}
game_data note
Data Example:
{
"info": {
"live_client_data": {
"game_data": {
"gameMode": "ARAM",
"gameTime": 0.0417339988052845,
"mapName": "Map12",
"mapNumber": 12,
"mapTerrain": "Default"
}
}
},
"feature": "live_client_data"
}
port note
Data Example:
{"info":{"live_client_data":{"port":53988}},"feature":"live_client_data"}
matchState
Info Updates
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
matchStarted | game_info | true/false (string) | See notes | 140.0 |
matchId | game_info | Current match id | See notes | 120.0 |
queueID | game_info | Current match queue id | See notes | 120.0 |
As there is no matchOutcome event for LoL, you can detect it by using the announcer or live_client_data events.
matchStarted note
Data Example:
{"info":{"game_info":{"matchStarted":"true"}},"feature":"matchState"}
matchId note
Data Example:
{"info":{"game_info":{"matchId":"2603009084"}},"feature":"game_info"}
queueID note
{"feature": "matchState", "category": "game_info", "key": "queueId", "data": "420"}
Events
Event | Event Data | Fired When | Notes | Since GEP Ver. |
---|---|---|---|---|
matchStart | null | Match has started | Match has started | 140.0 |
matchEnd | null | deprecated |
match_info
Info Updates
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
pseudo_match_id | match_info | Current match’s ID code. Example:a4e8fc75-b35e-466f-976c-09f4ee633d95 | This is an Overwolf-generated code unrelated to Riot Games. | 0.130 |
game_mode | match_info | Whether the current game mode is TFT, Arena or default LoL. See notes | 133.0 | |
match_paused | match_info | Whether a match is paused or not (Bool - True/False). See notes | 153.1 | |
players_tagline | match_info | Information about the players in the game. See notes | 240.0 |
game_mode notes
Data example:
{"feature": "match_info", "category": "match_info", "key": "game_mode", "data": "lol"}
{"feature": "match_info", "category": "match_info", "key": "game_mode", "data": "tft"}
{"feature": "match_info", "category": "match_info", "key": "game_mode", "data": "arena"}
match_paused note
Data Example:
{"info":{"match_info":{"match_paused":"true"}},"feature":"match_info"}
{"info":{"match_info":{"match_paused":"false"}},"feature":"match_info"}
players_tagline note
Include an array of all the players in the game with their tagLine
Data Example:
{"feature":"match_info","category":"match_info","key":"players_tagline","value":"[{\"playerName\":\"TacoNano888\",\"tagline\":\"12345\"},{\"playerName\":\"JacksAtPBE\",\"tagline\":\"1155\"},{\"playerName\":\"BestII\",\"tagline\":\"PBE\"},{\"playerName\":\"w is god\",\"tagline\":\"PBE\"},{\"playerName\":\"cvhjchj\",\"tagline\":\"PBE\"},{\"playerName\":\"1844043811\",\"tagline\":\"0731\"},{\"playerName\":\"ASUKA\",\"tagline\":\"chk\"},{\"playerName\":\"装高手不说话\",\"tagline\":\"4819\"},{\"playerName\":\"Veimll\",\"tagline\":\"PBE\"},{\"playerName\":\"sdadsda\",\"tagline\":\"das\"},{\"playerName\":\"MitsuriPBE\",\"tagline\":\"wewo\"},{\"playerName\":\"Soy Juanex\",\"tagline\":\"PBE\"}]"}
death
Info Updates
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
deaths | game_info | Number of deaths for this session | See notes | 77.0 |
deaths note
Data Example:
{"info":{"game_info":{"deaths":"1"}},"feature":"death"}
Events
Event | Event Data | Fired When | Notes | Since GEP Ver. |
---|---|---|---|---|
death | Number of deaths for this session | The player’s champion died | See notes | 77.0 |
death note
Data Example:
{"events":[{"name":"death","data":"{"count":"1"}"}]}
respawn
Events
Event | Event Data | Fired When | Notes | Since GEP Ver. |
---|---|---|---|---|
respawn | null | The player’s champion respawned | See notes | 140.0 |
respawn note
Data Example:
{"events":[{"name":"respawn","data":"{}"}]}
abilities
Info Updates
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
stack | stack | Local player's stack count of permanent stacking abilities | See notes | 238.0 |
stack note:
Local player's stack count of permanent stacking abilities for the following champions:
- Cho'Gath
- Shyvana
- Nasus
- Veigar
- Kindred
- Sion
- Thresh
- Swain
- Belveth
Data Example:
{"feature": "abilities", "category": "stack", "key": "stack", "data": "3"}
Events
Event | Event Data | Fired When | Notes | Since GEP Ver. |
---|---|---|---|---|
ability | ability number | player has selected an ability |
| 140.0 |
usedAbility | JSON containing: “type” with the ability number between 1-4. Example:{ type: "4" } for ult | player activated the ability | “usedAbility” fired when the player activated the ability | 0.31 |
ability note
Data Example:
{"events":[{"name":"ability","data":"1"}]}
usedAbility note
Data Example:
{"events":[{"name":"usedAbility","data":"{ "type": "1"}"}]}
{"events":[{"name":"usedAbility","data":"{ "type": "2"}"}]}
{"events":[{"name":"usedAbility","data":"{ "type": "3"}"}]}
{"events":[{"name":"usedAbility","data":"{ "type": "4"}"}]}
"usedAbility"is disabled for Udyr
kill
Info Updates
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
kills | game_info | Total kills in the match | See notes | 35.0 |
doubleKills | game_info | Total double-kills in the match | 35.0 | |
tripleKills | game_info | Total triple-kills in the match | 35.0 | |
quadraKills | game_info | Total quadra-kills in the match | 35.0 | |
pentaKills | game_info | Total penta-kills in the match | 35.0 |
kills note
{"info":{"game_info":{"kills":"1"}},"feature":"kill"}
{"info":{"game_info":{"doubleKills":"1"}},"feature":"kill"}
{"info":{"game_info":{"tripleKills":"1"}},"feature":"kill"}
{"info":{"game_info":{"quadraKills":"1"}},"feature":"kill"}
{"info":{"game_info":{"pentaKills":"1"}},"feature":"kill"}
Events
Event | Event Data | Fired When | Notes | Since GEP Ver. |
---|---|---|---|---|
kill | A JSON containing:
| Killing another champion | See notes | 70.0 |
kill note
Data Example:
{"events":[{"name":"kill","data":"{"label":"kill","count":"1","totalKills":"1"}"}]}
assist
Events
Event | Event Data | Fired When | Notes | Since GEP Ver. |
---|---|---|---|---|
assist | Number of times this event happened in the match | When you assist killing another champion | See notes | 70.00 |
assist note
Data Example:
{"events":[{"name":"assist","data":"{"count":"1"}"}]}
gold
Info Updates
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
gold | game_info | numeric value – amount of gold and total gold amount | See notes | 70.00 |
gold note
Data Example:
{"info":{"game_info":{"gold":"{\"gold\":\"717\", "total_gold":\"1119\"}"}},"feature":"gold"}
minions
Info Updates
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
minionKills | game_info | amount of enemy minions killed by the player | See notes | 70.0 |
neutralMinionKills | game_info | amount of neutral minions killed by the player | See notes | 70.0 |
minionKills note
Data Example:
{"info":{"game_info":{"minionKills":"37"}},"feature":"minions"}
neutralMinionKills note
Data Example:
{"info":{"game_info":{"neutralMinionKills":"2"}},"feature":"minions"}
summoner_info
Info Updates
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
id | summoner_info | User’s Summoner Id | Fired immediately with game start. Check notes | 70.0 |
region | summoner_info | User’s region (EUE, EUW, etc.) or PBE client (See notes) | Important note: Push runes/items feature is not allowed (by Riot) on Korea region, so in case your app provides such a feature, make sure to disable it for KR users. Also, check notes | 70.0 |
champion | summoner_info | Name of the selected champion | All champion names (provided by the Overwolf Game Events Provider) match the champion-key from the Riot API, except for Fiddlesticks .
Also, check notes | 70.0 |
level | summoner_info | User’s summoner level | See notes | 70.0 |
tier | summoner_info | User’s tier in his most played queue | See notes | 120.0 |
division | summoner_info | User’s division in his most played queue | See notes | 120.0 |
queue | summoner_info | Most played match queue | See notes | 120.0 |
accountId | summoner_info | User’s account id | See notes | 120.0 |
id note
Data Example:
{"info":{"summoner_info":{"id":"21549264"}},"feature":summoner_info}
region note
For a full list of regions and Riot Games Servers please visit here.
Data Example:
{"info":{"summoner_info":{"region":"EUNE"}},"feature":summoner_info}
Note that if the current client is a PBE client, instead of the region value, it returns "PBE":
{"info":{"summoner_info":{"region":"PBE"}},"feature":summoner_info}
Note that you can also get this info earlier by using the LEP region info-update.
champion note
{"info":{"summoner_info":{"champion":"Samira"}},"feature":summoner_info}
level note
Data Example:
{"info":{"summoner_info":{"level":"39"}},"feature":summoner_info}
tier note
Data Example:
{"info":{"summoner_info":{"tier":"IRON"}},"feature":summoner_info}
{"info":{"summoner_info":{"tier":"BRONZE"}},"feature":summoner_info}
{"info":{"summoner_info":{"tier":"SILVER"}},"feature":summoner_info}
{"info":{"summoner_info":{"tier":"GOLD"}},"feature":summoner_info}
{"info":{"summoner_info":{"tier":"PLATINUM"}},"feature":summoner_info}
{"info":{"summoner_info":{"tier":"DIAMOND"}},"feature":summoner_info}
{"info":{"summoner_info":{"tier":"MASTER"}},"feature":summoner_info}
{"info":{"summoner_info":{"tier":"GRANDMASTER"}},"feature":summoner_info}
{"info":{"summoner_info":{"tier":"CHALLENGER"}},"feature":summoner_info}
division note
Data Example:
{"info":{"summoner_info":{"division":"I"}},"feature":summoner_info}
{"info":{"summoner_info":{"division":"II"}},"feature":summoner_info}
{"info":{"summoner_info":{"division":"III"}},"feature":summoner_info}
{"info":{"summoner_info":{"division":"IV"}},"feature":summoner_info}
queue note
You may find the full list of queue types on Riot's API found here (Under queue types).
Data Example:
{"info":{"summoner_info":{"queue":"RANKED_SOLO_5x5"}},"feature":summoner_info}
accountId note
Data Example:
{"info":{"summoner_info":{"accountId":"25112115"}},"feature":summoner_info}
teams
teams
info-update might be provided a bit late in some game modes, as late as a few seconds before the loading screen ends. This is a known issue and we’re working on a fix.
Info Updates
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
teams | game_info | A URI – a decoded string that represents a JSON object with the team's formation | Need to use decodeURI() the value and then JSON.parse() the result. See the example below. | 70.0 |
Let's assume we save the data in a variable called info
. It will be the equivalent of:
var info = {"info":[{"category":"game_info","key":"teams","value":
"%5B%7B%22team%22:%22Order%22,%22champion%22:%22Riven%22,%22skinId%22:%227%22,%22summoner%22:%22ruizete%22%7D,
%7B%22team%22:%22Order%22,%22champion%22:%22Twitch%22,%22skinId%22:%228%22,%22summoner%22:%22heaser%22%7D,
%7B%22team%22:%22Order%22,%22champion%22:%22Vi%22,%22skinId%22:%222%22,%22summoner%22:%22hono%20kyumin%22%7D,
%7B%22team%22:%22Order%22,%22champion%22:%22Brand%22,%22skinId%22:%225%22,%22summoner%22:%22s%C3%A2baki%22%7D,
%7B%22team%22:%22Order%22,%22champion%22:%22Kennen%22,%22skinId%22:%226%22,%22summoner%22:%22fupnlul%22%7D,
%7B%22team%22:%22Chaos%22,%22champion%22:%22Nunu%22,%22skinId%22:%226%22,%22summoner%22:%22john1126y%22%7D,
%7B%22team%22:%22Chaos%22,%22champion%22:%22Orianna%22,%22skinId%22:%220%22,%22summoner%22:%22lp%20omg%20cartman%22%7D,
%7B%22team%22:%22Chaos%22,%22champion%22:%22Ryze%22,%22skinId%22:%227%22,%22summoner%22:%22bigmoney%C5%82egolas%22%7D,
%7B%22team%22:%22Chaos%22,%22champion%22:%22Malzahar%22,%22skinId%22:%220%22,%22summoner%22:%22hell0w0rld%22%7D,
%7B%22team%22:%22Chaos%22,%22champion%22:%22Kayn%22,%22skinId%22:%220%22,%22summoner%22:%22erikolo878%22%7D%5D"}]}
So now we will decode the value:
var decoded = decodeURI(info.info[0].value);
And get:
"[{"team":"Order","champion":"Riven","skinId":"7","summoner":"ruizete"},
{"team":"Order","champion":"Twitch","skinId":"8","summoner":"heaser"},
{"team":"Order","champion":"Vi","skinId":"2","summoner":"hono kyumin"},
{"team":"Order","champion":"Brand","skinId":"5","summoner":"sâbaki"},
{"team":"Order","champion":"Kennen","skinId":"6","summoner":"fupnlul"},
{"team":"Chaos","champion":"Nunu","skinId":"6","summoner":"john1126y"},
{"team":"Chaos","champion":"Orianna","skinId":"0","summoner":"lp omg cartman"},
{"team":"Chaos","champion":"Ryze","skinId":"7","summoner":"bigmoneyłegolas"},
{"team":"Chaos","champion":"Malzahar","skinId":"0","summoner":"hell0w0rld"},
{"team":"Chaos","champion":"Kayn","skinId":"0","summoner":"erikolo878"}]"}
Finally, we parse the string and get a JSON array with the teams:
var teams = JSON.parse(decoded);
level
Info Updates
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
level | level | Current level of the player's champion | Fired immediately when the game starts, updates whenever the champion levels up | 0.19 |
{ "info": {
"level": { "level": "1" }
},
"feature": "level"
}
announcer
Events
Event | Event Data | Fired When (announcement) | Notes | Since GEP Ver. |
---|---|---|---|---|
welcome_rift | null | “Welcome to Summoner’s Rift!” | 70.05 | |
minions_30_sec | null | “Thirty seconds until minions spawn!” | 70.05 | |
minions_spawn | null | “Minions have spawned!” | 70.05 | |
first_blood | null | “First Blood!” | 70.05 | |
defeat | null | “Defeat!” | 70.05 | |
victory | null | “Victory!” | 75.0 | |
shutdown | null | “Shut down!” | 75.0 | |
ace | null | “Aced!” | 75.0 | |
slain | “team” | “An enemy has been slain!!” | 75.0 | |
self_slain | “team” | “You have slain an enemy!!” | 75.0 | |
killing_spree | “team” | “Killing Spree!” | 75.0 | |
rampage | “team” | “Rampage!” | 75.0 | |
unstoppable | “team” | “Unstoppable” | 75.0 | |
dominating | “team” | “Dominating!” | 75.0 | |
godlike | “team” | “Godlike!” | 75.0 | |
legendary | “team” | “Legendary!” | 75.0 | |
double_kill | “team” | “Double Kill!” | 75.0 | |
triple_kill | “team” | “Triple Kill!” | 75.0 | |
quadra_kill | “team” | “Quadra Kill!” | 75.0 | |
penta_kill | “team” | “Penta Kill!” | 75.0 | |
turret_destroy | "team" | “Your turret has been destroyed!” | 75.0 | |
inhibitor_destroy | “team” | “Your inhibitor has been destroyed!” | 75.0 | |
slain | "enemy" | “An ally has been slain!” | 75.0 | |
slain_self | “enemy” | “You have been slain!” | 75.0 | |
killing_spree | “enemy” | “Enemy Killing Spree!” | 75.0 | |
rampage | “enemy” | “Enemy Rampage!” | 75.0 | |
unstoppable | “enemy” | “An enemy is Unstoppable!” | 75.0 | |
dominating | “enemy” | “An enemy is Dominating!” | 75.0 | |
godlike | “enemy” | “An enemy is Godlike!” | 75.0 | |
double_kill | “enemy” | “Enemy Double Kill!” | 75.0 | |
triple_kill | “enemy” | “Enemy Triple Kill!” | 75.0 | |
quadra_kill | “enemy” | “Enemy Quadra Kill!” | 75.0 | |
penta_kill | “enemy” | “Enemy Penta Kill!” | 75.0 | |
inhibitor_destroy | “enemy” | “Your team has destroyed an inhibitor!” | 75.0 | |
turret_destroy | “enemy” | “Your team has destroyed a turret!” | 75.0 | |
executed | "minion" | “Executed!” | 75.0 | |
executed | "tower" | “Executed!” | 75.0 |
counters
Info Updates
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
ping | performance | The change in latency values of the local player | See notes | 128.0 |
Events
Event | Event Data | Fired When | Notes | Since GEP Ver. |
---|---|---|---|---|
match_clock | The exact time in the match (in seconds). | Every second that the clock is ticking. | See notes | 138.0 |
ping note
Data Example:
{"info":{"performance":{"ping":"77"}},"feature":"counters"}
match_clock note
Data Example:
{"events":[{"name":"match_clock","data":"1249"}]}
gameMode
gameMode note
The information provided by this feature is incorrect at the moment. Please use "queueID" instead. (can be found either in the launcher events provider or in the game events provider).
- matchState You can redirect from here.
damage
Info Updates
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
total_damage_dealt | damage | Value of all damage done in the match (Float). | See notes | 139.0 |
total_damage_dealt_to_champions | damage | Value of all damage done to champions in the match (Float). | See notes | 139.0 |
total_damage_taken | damage | Value of all the damage that was taken in the match (Float). | See notes | 139.0 |
total_damage_dealt_to_buildings | damage | Value of all damage done to structures in the match (Float). | See notes | 139.0 |
total_damage_dealt_to_turrets | damage | Value of all damage done to turrets in the match (Float). | See notes | 139.0 |
total_damage_dealt_to_objectives | damage | Value of all damage given to objectives in the match (Float). | See notes | 139.0 |
total_damage_self_mitigated | damage | Value of all mitigated damage in the match (Float). | See notes | 139.0 |
total_damage_dealt note
Data Example:
{"info":{"damage":{"total_damage_dealt":"65.000000"}},"feature":"damage"}
total_damage_dealt_to_champions note
Data Example:
{"info":{"damage":{"total_damage_dealt_to_champions":"65.000000"}},"feature":"damage"}
total_damage_taken note
Data Example:
{"info":{"damage":{"total_damage_taken":"8.452381"}},"feature":"damage"}
total_damage_dealt_to_buildings note
Data Example:
{"info":{"damage":{"total_damage_dealt_to_buildings":"49.191074"}},"feature":"damage"}
total_damage_dealt_to_turrets note
Data Example:
{"info":{"damage":{"total_damage_dealt_to_turrets":"49.191074"}},"feature":"damage"}
total_damage_dealt_to_objectives note
Data Example:
{"info":{"damage":{"total_damage_dealt_to_objectives":"49.191074"}},"feature":"damage"}
total_damage_self_mitigated note
Data Example:
{"info":{"damage":{"total_damage_self_mitigated":"62.607620"}},"feature":"damage"}
Events
Event | Event Data | Fired When | Notes | Since GEP Ver. |
---|---|---|---|---|
physical_damage_dealt_player | Float | Damaging an opponent with physical damage. | See notes | 139.0 |
magic_damage_dealt_player | Float | Damaging an opponent with magic damage. | See notes | 139.0 |
true_damage_dealt_player | Float | Damaging an opponent with true damage. | See notes | 139.0 |
physical_damage_dealt_to_champions | Float | Physical damage is inflicted on any opponent. | See notes | 139.0 |
magic_damage_dealt_to_champions | Float | Magic damage is inflicted on any opponent. | See notes | 139.0 |
true_damage_dealt_to_champions | Float | True damage is inflicted on any opponent. | See notes | 139.0 |
physical_damage_taken | Float | Receiving physical damage from an opponent. | See notes | 139.0 |
magic_damage_taken | Float | Receiving magic damage from an opponent. | See notes | 139.0 |
true_damage_taken | Float | Receiving true damage from an opponent. | See notes | 139.0 |
physical_damage_dealt_player note
Data Example:
{"events":[{"name":"physical_damage_dealt_player","data":"47.65625"}]}
magic_damage_dealt_player note
Data Example:
{"events":[{"name":"magic_damage_dealt_player","data":"65.0"}]}
true_damage_dealt_player note
Data Example:
{"events":[{"name":"true_damage_dealt_player","data":"14.0"}]}
physical_damage_dealt_to_champions note
Data Example:
{"events":[{"name":"physical_damage_dealt_to_champions","data":"47.65625"}]}
magic_damage_dealt_to_champions note
Data Example:
{"events":[{"name":"magic_damage_dealt_to_champions","data":"65.0"}]}
true_damage_dealt_to_champions note
Data Example:
{"events":[{"name":"true_damage_dealt_to_champions","data":"14.0"}]}
physical_damage_taken note
Data Example:
{"events":[{"name":"physical_damage_taken","data":"8.452381"}]}
magic_damage_taken note
Data Example:
{"events":[{"name":"magic_damage_taken","data":"11.355035"}]}
true_damage_taken note
Data Example:
{"events":[{"name":"true_damage_taken","data":"6.0"}]}
heal
Info Updates
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
total_heal | heal | Value of all healing done in the match (Float). | See notes | 139.0 |
total_heal_on_teammates | heal | Value of all healing on teammates in the match (Float). | See notes | 139.0 |
total_units_healed | heal | Value of amount of units healed in the match (Float). | See notes | 139.0 |
total_heal note
Data Example:
{"info":{"heal":{"total_heal":"27.0"}},"feature":"heal"}
total_heal_on_teammates note
Data Example:
{"info":{"heal":{"total_heal_on_teammates":"27.0"}},"feature":"heal"}
total_units_healed note
Data Example:
{"info":{"heal":{"total_units_healed":"1.0"}},"feature":"heal"}
jungle_camps
Info Updates
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
jungle_camp_xx | jungle_camps | Name of each camp. | See notes | 186.0 |
jungle_camp note:
Boolean values:
- alive - true/false representing whether they are alive or dead (this information is true whether it is killed by an enemy or an ally).
- vision - true/false representing whether we have a vision on the camp in question (vision is being updated once the alive state changes).
Icon values:
- 0 - This means there is no icon indicator in the minimap for the relevant camp.
- 1 - Displaying silver icon (long respawn indicator) for the relevant camp.
- 2 - Displaying gold icon (short respawn indicator) for the relevant camp.
Possible Values:
- Blue West
- Blue East
- Wolves West
- Wolves East
- Raptors West
- Raptors East
- Red West
- Red East
- Krug West
- Krug East
- Dragon
- Baron (icon_status always remains zero).
- Gromp West
- Gromp East
- Scuttle Crab River Bot side
- Scuttle Crab River Top side
- Rift Herald (icon_status always remains zero).
- VoidGrubs (icon_status always remains zero).
Note that the jungle camps IDs are no longer static and can change from time to time. The field name is holding the actual camp name.
Data Example:
{"feature": "jungle_camps", "category": "jungle_camps", "key": "jungle_camp_0", "data": "{\"name\":\"Blue West\",\"alive\":false,\"vision\":false,\"icon_status\":\"1\"}"}
{"feature": "jungle_camps", "category": "jungle_camps", "key": "jungle_camp_3", "data": "{\"name\":\"Red East\",\"alive\":false,\"vision\":false,\"icon_status\":\"2\"}"}
{"feature": "jungle_camps", "category": "jungle_camps", "key": "jungle_camp_7", "data": "{\"name\":\"Wolves East\",\"alive\":true,\"vision\":true,\"icon_status\":\"0\"}"}
team_frames
Info Updates
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
team_frames_x | game_info | Cooldown timer of the ultimate of the players in seconds. | See notes | 193.0 |
team_frames note:
This info update shows the cooldown timer of the ultimate ability of each player in seconds.
Value in "team_frames_0" is the player to the left until "team_frames_3" to the last player to the right.
The value in ult_cd stands for ultimate cooldown in seconds.
{"info":{"game_info":{"team_frames_1":"{\"ult_cd\":47}"}},"feature":"team_frames"}
chat
This event is intended for real-time usage only, and its content should not be logged.
Events
Event | Event Data | Fired When | Notes | Since GEP Ver. |
---|---|---|---|---|
chat | All the chat messages sent in a match | Every time there is a new message in the chat | See notes | 224.0 |
chat note
Data Example:
{"events":[{"name":"chat","data":"[Team] Jacksork (Lux): Hello "}]}