Loading...
- Game events API
Please read the overwolf.games.events documentation page to learn how to use Overwolf game events.
Note that LOL Arena, LOL Arena PBE and LOL share the same Game ID.
tip
Note that you can also use the LOL game launcher events. Read more here.
Sample Apps
Available Features
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.
info
Because LOL and LOL Arena share the same GameID, when checking LOL Arenas game event status please use 21556 as the unique GameID for LOL Arena and 215561 for LOL Arena 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"}
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 | 230.0 |
all_players | live_client_data | In-game data received by the client. | See notes | 230.0 |
events | live_client_data | In-game data received by the client. | See notes | 230.0 |
game_data | live_client_data | In-game data received by the client. | See notes | 230.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"
}
matchState
Info Updates
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
matchStarted | game_info | true/false (string) | See notes | 230.0 |
matchId | game_info | Current match id | See notes | 230.0 |
matchStarted note
Data Example:
{"info":{"game_info":{"matchStarted":"true"}},"feature":"matchState"}