Skip to main content

Apex Legends

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

Sample Apps

Available Features

Game event status

It is highly recommended to communicate errors and warnings to app users.

Check the current game event status here. Alternately, you can easily check that status from your app itself, using our API.

gep_internal

Info Updates

keyCategoryValuesNotesSince GEP Ver.
gep_internalgep_internalLocal + Public version numberSee notes143.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"}

me

Info Updates

keyCategoryValuesNotesSince GEP Ver.
namegame_infoLocal Player NameSee notes128.0
ultimate_cooldownmeUltimate ability cooldown (range between 0-100)See notes128.0

name note

Data Example:

{"info":{"me":{"name":"Shargaas"}},"feature":"me"}

ultimate_cooldown note

Data Example:

{"info":{"me":{"ultimate_cooldown":"{\"ultimate_cooldown\":\"15\"}"}},"feature":"me"}

match_info

Info Updates

keyCategoryValuesNotesSince GEP Ver.
pseudo_match_idmatch_infoThe current match’s ID code.

Example:

0c0ea3df-97ea-4d3a-b1f6-f8e34042251f
This is an Overwolf-generated code, unrelated to Respawn.130.0
game_modematch_infoThe currently selected game mode.See notes158.0
tabsmatch_infoThe current amount of squads, players, cash, and kills of the match (in relation to local player).See notes158.0

game_mode note

Data Example:

{"info":{"match_info":{"game_mode":"#PL_TRIO"}},"feature":"match_info"}

Possible values:

  • "#PL_FIRINGRANGE"
  • "#PL_TRAINING"
  • "#PL_DUO"
  • "#PL_TRIO"
  • "#PL_Ranked_Leagues"
  • "#SHADOWROYALE_MODE"

Note that we get these values from the game, so they might be changed from season to season.

tabs note

Data Example:

{"info":{"match_info":{"tabs":"{\"kills\":2,\"assists\":1,\"teams\":4,\"players\":10,\"damage\":440,\"cash\":10}"}},"feature":"match_info"}

match_state

Info Updates

keyCategoryValuesNotesSince GEP Ver.
match_stategame_infoactive/inactiveSee notes128.0

Events

EventEvent DataFired WhenNotesSince GEP Ver.
match_startnullMatch startedSee notes128.0
match_endnullMatch endedSee notes128.0

match_state note

Data Example:

{"info":{"game_info":{"match_state":"active"}},"feature":"match_state"}
{"info":{"game_info":{"match_state":"inactive"}},"feature":"match_state"}

match_start note

Data Example:

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

match_end note

Currently we have a special case where if someone in your team got a yellow knockdown shield (the one that allows you to self-revive), and your entire team was knocked out, the match end will still fire despite no one reaching a death-state. This is a very rare case that does not commonly happen in the game, however we're still working on fixing it.

team

Info Updates

keyCategoryValuesNotesSince GEP Ver.
teammate_Xmatch_infoThis feature provides the list of your squad members.128.0
legendSelect_Xmatch_infoThe name of the legend & order of selection for every member in the team, including noting who the jump-master is.128.0

| match_info | The current status of the local player’s team. | | 128.0 |

teammate_X notes

Each squad member joining the game will be reported in the following way:

{"info":{"match_info":{"teammate_0":"{\"name\":\"JacksAtWork\",\"state\":\"knocked_out\"}"}},"feature":"team"}

As you can see, this object includes:

  • player – Player name
  • state – alive/death/knocked out

legendSelect_X notes

Every team member, including the jump-master will be reported in the following way:

{"info":{"match_info":{"legendSelect_0":"{\"playerName\":\"[B1ER] Rango\",\"legendName\":\"#character_pathfinder_NAME\",\"selectionOrder\":\"0\",\"lead\":true}"}},"feature":"team"}

team_info notes

The current status of the local player’s team ("active" or "eliminated").

{"info":{"match_info":{"team_info":"{\"team_state\":\"active\"}"}},"feature":"team"}

As you can see, this object includes:

  • Selection order
  • Legend name
  • Jumpmaster - Bool True/False

roster

Info Updates

keyCategoryValuesNotesSince GEP Ver.
roster_XXmatch_infoProvides the entire list of players in a match (~60 players).128.0

roster_XX notes

Each player joining the game will be reported in the following way:

{"info":{"match_info":{"roster_47":"{\"name\":\"JacksAtWork\",\"isTeammate\":true,\"team_id\":12,\"platform_hw\":2,\"platform_sw\":7,\"state\":\"knocked_out\",\"is_local\":\"1\"}"}},"feature":"roster"}

As you can see, this object includes:

  • name - Player name
  • isTeammate (Bool) - Player is/isn't a squad member
  • team_id - Numerical value for each squad in-game.
  • platform - The platform which the player plays on currently.
  • is_local - where 1 is the local player else 0.

Possible platform values:

  • "platform_hw":2,"platform_sw":2 = PC/Origin
  • "platform_hw":2,"platform_sw":7 = PC/Steam
  • "platform_hw":1,"platform_sw":1 = PS4 / PS5
  • "platform_hw":9,"platform_sw":9 = OG Switch
  • "platform_hw":0,"platform_sw":0 = Xbox one X

location

Info Updates

keyCategoryValuesNotesSince GEP Ver.
locationmatch_infoSee example below130.0

location notes

  • Map Center is (0,0,z)
  • King's Canyon appears to be 1x1km
  • Location is polled up to two times in 1 second
  • Location is accurate to a 1 meter resolution, do not use fractions of meters

Event data example

{"info":{"match_info":{"location":"{"x":"93","y":"305","z":"49"}"}},"feature":"location"}

rank

Info Updates

keyCategoryValuesNotesSince GEP Ver.
victorymatch_infotrue/falseTriggers at the end of each round. Value “true” for winning and “false” for losing.128.0

victory note

Data Example:

{"info":{"match_info":{"victory":"false"}},"feature":"rank"}
{"info":{"match_info":{"victory":"true"}},"feature":"rank"}

match_summary

Info Updates

keyCategoryValuesNotesSince GEP Ver.
match_summarymatch_info130.0

match_summary notes

After a match, this will return:

  • The final position the squad has reached (ranked 1-20)
  • Total number of teams in the match
  • Total number of kills made by the squad

Event data example

{"info":{"match_info":{"match_summary":"{"rank":"12","teams":"20","squadKills":"5"}"}},"feature":"match_summary"}

damage

Info Updates

keyCategoryValuesNotesSince GEP Ver.
totalDamageDealtmeThe total amount of damage inflicted in a match of Apex. See example below.130.0

totalDamageDealt notes

Note that the game does not count damage that is inflicted on Armor, only Health damage after the armor was broken. However, our damage report includes damage done to armor, so it will always be higher than the in-game damage.

Event data example

{"info":{"me":{"totalDamageDealt":"115"}},"feature":"damage"}

Events

EventEvent DataFired When (announcement)NotesSince GEP Ver.
damageSee example belowWhen the local player deals damage to another player.130.0

damage notes

The following properties are provided:

  • targetName
  • damageAmount
  • armor
  • headshot
  • grenade

Event data example

{"events":[{"name":"damage","data":"{\r\n  \"targetName\": \"TMW_JayJay\",\r\n  \"damageAmount\": \"15.000000\",\r\n  \"armor\": \"true\",\r\n  \"headshot\": \"false\"\r\n}"}]}

inventory

Info Updates

keyCategoryValuesNotesSince GEP Ver.
inventory_XXmeLists the items picked up into the local player's inventory (Tab).
Example:
{"name":"unknown_42","amount":"40"}
130.0
weaponsmeWeapons currently used by the local player - there are two slots available marked 0 and 1.
Example:
{"weapon0":"Wingman","weapon1":"Alternator SMG"}
0.130
inUsemeItems currently used by the local player.
Example:
{"inUse":"Kunai Melee"}
0.130

weapons note

Data Example:

{"info":{"me":{"weapons":"{\"weapon0\":\"R-99\",\"weapon1\":\"Melee\"}"}},"feature":"inventory"}

inUse note

Data Example:

{"info":{"me":{"inUse":"{\"inUse\":\"R-99\"}"}},"feature":"inventory"}

kill

Events

EventEvent DataFired WhenNotesSince GEP Ver.
killvictimNameLocal player killed another player. {"victimName": "6ewehrw0lf"}130.0
knockdownvictimNameLocal player knocked out another player. {"victimName":"J0GUR7"}130.0
assistvictimNameLocal player participated in a team member’s kill.

Provided values:
1. victimName
2. type - knockdown / elimination

Example:

{"victimName":"VioletAlbicocca","type":"knockdown"}
130.0

kill note

  • Currently performing an execution does not catch a kill event. If you want to correctly count the amount of kills despite this issue, please use the new tabs key in the match_info feature.
  • Furthermore, assist in a knockdown event currently is not supported, only for elimination.

Data Example:

{"events":[{"name":"kill","data":"{  "victimName": "`1[LuL] Sladdi #limbo"}"}]}

knockdown note

Data Example:

{"events":[{"name":"knockdown","data":"{  "victimName": "`1 Kixfoxn"}"}]}

assist note

Data Example:

{"events":[{"name":"assist","data":"{  "victimName": "kazikov.qwerty",  "type": "elimination"}"}]}

revive

Events

EventEvent DataFired WhenNotesSince GEP Ver.
healed_from_konullLocal player was revived from knocked out state.See notes128.0
respawnnullLocal player was returned to the game at a beacon.See notes128.0

healed_from_ko note

Data Example:

{"events":[{"name":"healed_from_ko","data":null}]}

respawn note

Data Example:

{"events":[{"name":"respawn","data":null}]}

death

Events

EventEvent DataFired WhenNotesSince GEP Ver.
knocked_outnullLocal player’s health drops to zero.See notes128.0
deathnull (in the future we will provide the killer name).Local player died during knocked out state.There is another health bar during knocked out
state, it’s orange, above the player name. See notes
128.0

knocked_out note

Data Example:

{"events":[{"name":"knocked_out","data":null}]}

death note

Data Example:

{"events":[{"name":"death","data":null}]}

kill_feed

Events

EventEvent DataFired WhenNotesSince GEP Ver.
kill_feedSee example belowWhen information is presented on the game’s UI (top right corner).130.0

kill_feed notes

The following properties are provided:

  • local_player_name
  • attackerName
  • victimName
  • weaponName
  • action

Action possible values:

  • kill
  • headshot_kill
  • knockdown
  • Bleed_out
  • Finisher
  • Melee
  • Smoke Launcher
  • Creeping Barrage
  • Caustic Gas
  • Kunai Melee
  • Perimeter Security
  • Defensive Bombardment

Event data example

{"events":[{"name":"kill_feed","data":"{"local_player_name":"Shargaas","attackerName":"shayan3200", "victimName":"i999n","weaponName":"alternator","action":"knockdown"}"}]}

"Bleed Out" note

The weaponName can return with a "Bleed Out" value. For example:

"events": [{
"name": "kill_feed",
"data": {
"attackerName": "Red_Wizard19TTV",
"victimName": "SoSochek_1337",
"weaponName": "Bleed Out",
"action": "Bleed Out"
}
}]

"Bleed Out" is when something "external" kills you, which is not an enemy player.
For example, if you are knocked out already, and you are outside of the safe zone, your HP automatically depletes, and when it reaches zero, and you die, you will Bleed Out, and the weaponName and action will return with the "Bleed Out" value. The same rules apply for the "Caustic" legend gas barrels; if they kill you, you also receive a "Bleed Out."