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"}
matchID note
Data Example:
{"info":{"game_info":{"matchId":"2603009084"}},"feature":"game_info"}
Events
| Event | Event Data | Fired When | Notes | Since GEP Ver. |
|---|---|---|---|---|
| matchStart | null | Match has started | Match has started | 230.0 |
match_info
Info Updates
| key | Category | Values | Notes | Since GEP Ver. |
|---|---|---|---|---|
| round_number | match_info | The number of the current round | See notes | 230.0 |
| match_outcome | match_info | The final march outcome | See notes | 230.0 |
round_number notes
Data example:
{"info":{"match_info":{"round_number":"4"}},"feature":"match_info"}
match_outcome note
Match outcome at the end of the match with your team's place
Possible status values:
- victory
- defeat
Possible place values are 1, 2, 3, 4
Data Example:
{"info":{"match_info":{"match_outcome":"{\"status\":\"defeat\",\"place\":4}"}},"feature":"match_info"}
Events
| Event | Event Data | Fired When | Notes | Since GEP Ver. |
|---|---|---|---|---|
| round_start | the current round number | A round start | See notes | 230.0 |
| round_end | null | A round is won or lost | See notes | 230.0 |
| round_outcome | null | At the end of the current round | See notes | 230.0 |
| battle_start | null | The battle start | See notes | 253.0 |
| battle_end | null | The battle end | See notes | 253.0 |
round_start note
Data Example:
{"events":[{"name":"round_start","data":"3"}]}
round_end note
Data Example:
{"events":[{"name":"round_end","data":""}]}
round_outcome notes
Data example:
{"events":[{"name":"round_outcome","data":"defeat"}]}
battle_start note
Data Example:
{"events":[{"name":"battle_start","data":""}]}
battle_end note
Data Example:
{"events":[{"name":"battle_end","data":""}]}
summoner_info
Info Updates
| key | Category | Values | Notes | Since GEP Ver. |
|---|---|---|---|---|
| id | summoner_info | User’s Summoner Id | Fired immediately with game start. See notes | 230.0 |
| region | summoner_info | User’s region (EUE, EUW, etc.) or PBE client (See notes) | See notes | 230.0 |
| level | summoner_info | User’s summoner level | See notes | 230.0 |
| accountId | summoner_info | User’s account id | See notes | 230.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.
level note
Data Example:
{"info":{"summoner_info":{"level":"39"}},"feature":summoner_info}
accountId note
Data Example:
{"info":{"summoner_info":{"accountId":"25112115"}},"feature":summoner_info}
teams
Info Updates
| key | Category | Values | Notes | Since GEP Ver. |
|---|---|---|---|---|
| teams | game_info | Deprecated | See notes | 70.0 |
| arena_teams | game_info | A JSON object with the teams formation | See notes | 70.0 |
teams note
caution
teams is deprecated and will be replaced by arena_teams - See notes
arena_teams note
The info-update JSON response will return the following parameters:
- team - a random team number
- players - an array of players
- name - the player name with tagline
- is_local - true/false to identify the local player
{"feature":"teams","category":"game_info","key":"arena_teams","value":"[{\"team\":\"0\",\"players\":[{\"name\":\"Rosenkeskole8#EUW\"},{\"is_local\":false},{\"name\":\"Rosenkikole9#EUW\"},{\"is_local\":false}]},{\"team\":\"1\",\"players\":[{\"name\":\"Atgucuu#EUW\"},{\"is_local\":false},{\"name\":\"Maks#EUW\"},{\"is_local\":false}]},{\"team\":\"2\",\"players\":[{\"name\":\"Nanoco#6874\"},{\"is_local\":true},{\"name\":\"iamigMac#EUW\"},{\"is_local\":false}]},{\"team\":\"3\",\"players\":[{\"name\":\"ProusRex#EUW\"},{\"is_local\":false},{\"name\":\"Vipel60#EUW\"},{\"is_local\":false}]},{\"team\":\"4\",\"players\":[{\"name\":\"Shâ#EUW\"},{\"is_local\":false},{\"name\":\"Stgaim#EUW\"},{\"is_local\":false}]},{\"team\":\"5\",\"players\":[{\"name\":\"7mdo#EUW\"},{\"is_local\":false},{\"name\":\"Pacan#EUW\"},{\"is_local\":false}]},{\"team\":\"6\",\"players\":[{\"name\":\"Tamaotau#Mommy\"},{\"is_local\":false},{\"name\":\"xM4#EUW\"},{\"is_local\":false}]},{\"team\":\"7\",\"players\":[{\"name\":\"Rosenkild3#EUW\"},{\"is_local\":false},{\"name\":\"skoleX#EUW\"},{\"is_local\":false}]}]"}
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"}
match
Info Updates
| key | Category | Values | Notes | Since GEP Ver. |
|---|---|---|---|---|
| match_started | game_info | Match has started | See notes | 230.0 |
Events
| key | Category | Values | Notes | Since GEP Ver. |
|---|---|---|---|---|
| match_start | match start event | See notes | 230.0 |
match_started note
Data Example:
{"feature":"match","category":"game_info","key":"match_started","value":true}
match_start note
Data Example:
{"events":[{"name":"match_start","data":""}]}
augments
Info Updates
| key | Category | Values | Notes | Since GEP Ver. |
|---|---|---|---|---|
| augments | me | List of available augments | See notes | 230.0 |
| picked_augment | me | The last augment that the player picked | See notes | 222.0 |
augments note
Data Example:
{"feature":"augments","category":"me","key":"augments","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"}
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_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_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"}
Loading...