ESO Lua API — the empirical reference

ZOS's API documentation tells you a function exists; it doesn't tell you whether anyone uses it or how. We indexed the source of every addon on ESOUI (3,030 addons) and matched it against the official API docs (version 101050), so every entry here shows the official signature plus how many real addons call it and a real, attributed usage example. These are the 400 most-used API symbols — usage-ranked, not alphabetical.

corpus snapshot 2026-07-24 · official signatures from ESOUIDocumentation.txt (API 101050)

Functions (373)

Symbol	Addons using it	Their combined downloads
`EVENT_ADD_ON_LOADED`	2,598	346,064,146
`EVENT_PLAYER_ACTIVATED`	1,275	233,599,707
`GetString`	1,111	230,547,018
`GetCVar`	652	190,304,200
`GetUnitName`	630	91,638,782
`PlaySound`	571	80,728,461
`GetItemLink`	466	116,971,287
`GetWorldName`	454	77,613,313
`GetDisplayName`	451	157,660,046
`EVENT_PLAYER_COMBAT_STATE`	450	61,840,310
`IsUnitInCombat`	413	56,119,121
`GetTimeStamp`	406	103,920,764
`ReloadUI`	393	60,178,100
`GetGameTimeMilliseconds`	388	97,250,008
`EVENT_INVENTORY_SINGLE_SLOT_UPDATE`	343	95,407,860
`GetFrameTimeMilliseconds`	339	46,614,312
`GetUnitDisplayName`	326	40,438,364
`EVENT_COMBAT_EVENT`	295	55,226,317
`EVENT_EFFECT_CHANGED`	282	63,230,405
`CreateControlFromVirtual`	255	81,827,999
`GetGuildId`	251	39,925,581
`GetGroupSize`	249	49,457,547
`GetBagSize`	243	44,771,786
`RequestOpenUnsafeURL`	241	43,490,129
`GetItemLinkName`	238	94,618,551
`EVENT_GLOBAL_MOUSE_UP`	234	31,945,350
`GetGuildName`	229	37,441,559
`GetItemLinkItemType`	218	97,691,598
`GetZoneId`	215	66,151,282
`GetNumBuffs`	213	36,807,939
`GetUnitBuffInfo`	212	36,552,501
`SetCameraOptionsPreviewModeEnabled`	206	15,282,611
`IsInGamepadPreferredMode`	204	119,479,705
`SetColor`	202	14,804,599
`GetUnitZoneIndex`	199	38,411,776
`GetUnitPower`	199	21,070,170
`GetSetting`	198	34,027,032
`GetAbilityName`	197	54,399,192
`GetNumGuilds`	196	21,606,109
`GetItemLinkSetInfo`	189	76,927,995
`SetSetting`	189	11,484,305
`DoesUnitExist`	186	51,523,005
`GetGroupUnitTagByIndex`	177	35,184,447
`GetItemLinkItemId`	169	71,939,812
`IsUnitDead`	168	14,829,020
`EVENT_CHAT_MESSAGE_CHANNEL`	167	35,662,335
`GetWindowManager`	167	36,157,487
`PushActionLayerByName`	167	17,184,866
`RemoveActionLayerByName`	166	17,889,161
`GetCurrentCharacterId`	161	46,250,909
`IsUnitGrouped`	161	21,323,134
`GetItemInfo`	159	57,902,177
`CallSecureProtected`	159	55,319,777
`GetInterfaceColor`	158	69,553,715
`SecurePostHook`	156	39,965,141
`EVENT_GROUP_MEMBER_LEFT`	151	42,486,696
`EVENT_GROUP_MEMBER_JOINED`	150	36,041,030
`GetItemName`	145	42,616,552
`GetUnitClassId`	142	38,034,817
`GetAPIVersion`	137	101,788,746
`GetSlotBoundId`	137	31,886,303
`GetGuildMemberInfo`	137	11,843,495
`GetItemType`	135	47,685,312
`GetItemLinkInfo`	132	43,245,810
`GetUnitWorldPosition`	123	29,889,280
`GetFrameTimeSeconds`	122	54,100,629
`GetItemId`	121	64,705,602
`GetMapPlayerPosition`	120	83,887,532
`GetAbilityIcon`	120	38,086,353
`EVENT_CRAFTING_STATION_INTERACT`	119	45,138,181
`GetZoneNameById`	117	43,262,113
`EVENT_POWER_UPDATE`	116	20,012,028
`GetGameCameraInteractableActionInfo`	115	43,650,802
`EVENT_LOOT_RECEIVED`	114	29,765,615
`EVENT_OPEN_BANK`	113	30,259,862
`EVENT_END_CRAFTING_STATION_INTERACT`	113	55,423,275
`GetNumGuildMembers`	111	6,882,572
`GetCharacterInfo`	109	23,565,994
`GetUnitZone`	108	9,651,036
`GetAddOnManager`	107	59,805,630
`EVENT_ACTIVE_WEAPON_PAIR_CHANGED`	106	19,462,159
`GetCurrencyAmount`	105	21,925,707
`CreateControl`	105	38,671,102
`GetRawUnitName`	104	22,561,179
`GetNumCharacters`	102	22,671,176
`GetUnitLevel`	101	17,547,414
`GetItemLinkWeaponType`	100	51,860,759
`GetItemLinkTraitInfo`	100	49,097,641
`GetTimeString`	99	17,459,717
`GetSlotStackSize`	98	17,168,002
`GetItemLinkArmorType`	97	67,954,880
`EVENT_QUEST_ADDED`	96	43,171,954
`GetCurrentMapZoneIndex`	96	66,151,901
`IsUnitOnline`	95	12,124,190
`EVENT_ACTION_LAYER_PUSHED`	94	31,912,559
`GetCollectibleInfo`	94	10,803,170
`IsPlayerInAvAWorld`	93	9,048,726
`EVENT_CHATTER_BEGIN`	91	24,174,294
`GetUnitAlliance`	91	22,473,688
`GetItemLinkEquipType`	91	49,282,574
`EVENT_ACTION_LAYER_POPPED`	91	23,676,733
`EVENT_ZONE_CHANGED`	90	21,541,809
`EVENT_UNIT_DEATH_STATE_CHANGED`	90	16,364,251
`UseCollectible`	90	1,868,665
`GetAchievementInfo`	89	64,289,847
`GetDateStringFromTimestamp`	89	12,966,594
`EVENT_BOSSES_CHANGED`	86	39,168,820
`GetGameTimeSeconds`	85	36,332,290
`IsActiveWorldBattleground`	85	13,365,309
`GetGroupMemberSelectedRole`	84	23,939,721
`GetCollectibleName`	82	17,083,663
`Id64ToString`	81	39,298,293
`AreUnitsEqual`	81	35,524,957
`IsUnitPlayer`	81	10,982,783
`GetItemLinkRequiredLevel`	79	33,568,850
`RequestJumpToHouse`	79	5,163,498
`EVENT_RETICLE_HIDDEN_UPDATE`	78	10,212,844
`GetSkillAbilityInfo`	77	35,182,706
`IsUnitInDungeon`	77	4,383,990
`GetAchievementCriterion`	76	41,494,617
`SetCVar`	76	13,912,577
`GetJournalQuestName`	74	29,727,109
`GetGuildMemberCharacterInfo`	73	6,500,538
`EVENT_QUEST_REMOVED`	72	30,673,195
`GetItemLinkRequiredChampionPoints`	72	32,577,226
`IsUnitGroupLeader`	72	9,642,941
`GetMapType`	71	84,248,779
`EVENT_ACTION_SLOT_ABILITY_USED`	71	30,007,596
`IsConsoleUI`	70	16,719,511
`GetJournalQuestInfo`	69	29,648,546
`GetCurrentZoneHouseId`	69	24,758,689
`GetInteractionType`	69	39,588,929
`EVENT_ACHIEVEMENT_AWARDED`	69	21,131,216
`GetDiffBetweenTimeStamps`	69	23,700,112
`IsProtectedFunction`	69	13,281,081
`EVENT_ACHIEVEMENT_UPDATED`	68	26,250,198
`GetItemLinkIcon`	67	45,349,917
`IsMounted`	67	10,446,150
`GetUnitGender`	67	11,599,557
`EVENT_CRAFT_COMPLETED`	66	40,558,478
`IsShiftKeyDown`	66	19,398,601
`GetCurrentZoneDungeonDifficulty`	66	16,427,764
`GetItemLinkStacks`	65	39,724,453
`GetAbilityDuration`	65	39,556,730
`GetActiveCollectibleByType`	64	5,611,019
`GetNumSkillLines`	63	27,817,215
`GetActiveWeaponPairInfo`	62	17,643,511
`GetTradingHouseSearchResultItemLink`	62	17,363,807
`GetAttachedItemLink`	62	21,654,134
`GetItemWeaponType`	61	23,052,655
`GetPlayerCameraHeading`	61	25,101,315
`GetNumJournalQuests`	61	18,912,041
`SetGameCameraUIMode`	61	11,776,673
`GetUnitStealthState`	61	3,171,605
`GetJournalQuestConditionInfo`	60	29,218,793
`EVENT_MOUNTED_STATE_CHANGED`	60	17,878,923
`GetGuildMemberIndexFromDisplayName`	60	4,280,262
`JumpToHouse`	60	2,197,000
`GetItemUniqueId`	59	45,333,194
`GetUnitRawWorldPosition`	59	15,131,009
`GetNumSmithingResearchLines`	59	18,760,578
`JumpToSpecificHouse`	59	5,893,657
`IsCollectibleUnlocked`	59	3,761,875
`EVENT_QUEST_COMPLETE`	58	19,021,216
`GetItemStyleName`	58	30,240,478
`EVENT_ACTION_SLOT_UPDATED`	58	25,443,639
`EVENT_ALLIANCE_POINT_UPDATE`	58	22,332,748
`FormatTimeSeconds`	58	13,497,236
`IsPlayerMoving`	58	4,777,826
`GetCurrentMapIndex`	57	39,941,292
`GetFriendInfo`	57	5,686,548
`GetSmithingResearchLineTraitInfo`	56	26,356,362
`GetSmithingResearchLineInfo`	56	19,549,406
`GetNumBagFreeSlots`	56	11,401,971
`GetHousingPrimaryHouse`	56	2,354,648
`EVENT_GAMEPAD_PREFERRED_MODE_CHANGED`	55	50,580,043
`EVENT_GUILD_SELF_JOINED_GUILD`	55	20,947,126
`GetNumFriends`	55	3,474,232
`GetLootItemLink`	54	37,740,795
`GetAchievementNumCriteria`	54	22,172,464
`GetSelectedLFGRole`	54	28,511,935
`GetAchievementRewardTitle`	54	6,003,687
`GetCraftingInteractionType`	53	27,242,288
`FindFirstEmptySlotInBag`	53	26,360,702
`EVENT_GROUP_MEMBER_CONNECTED_STATUS`	53	24,841,985
`GetNumBagUsedSlots`	53	12,157,976
`GetNumSkillAbilities`	52	18,714,876
`GetSmithingResearchLineTraitTimes`	52	13,241,610
`EVENT_GUILD_SELF_LEFT_GUILD`	52	19,100,918
`IsItemStolen`	52	9,007,015
`IsItemPlayerLocked`	52	8,304,225
`GetUnitChampionPoints`	51	10,681,843
`GetItemCondition`	51	11,857,308
`GetNumEmotes`	51	3,935,920
`GetMapName`	50	32,239,572
`EVENT_ACTIVE_QUICKSLOT_CHANGED`	50	16,244,321
`GetTradingHouseListingItemLink`	50	14,265,749
`GetFastTravelNodeInfo`	49	44,298,869
`GetMapTileTexture`	49	59,876,615
`GetMapContentType`	49	40,611,125
`EVENT_MONEY_UPDATE`	49	8,305,165
`GetGroupLeaderUnitTag`	49	4,100,063
`EVENT_UNIT_ATTRIBUTE_VISUAL_ADDED`	49	4,783,961
`DoesPlayerHaveGuildPermission`	49	3,013,371
`GetZoneNameByIndex`	48	32,247,617
`GetCurrentMapId`	48	58,492,045
`RedirectTexture`	48	16,383,433
`GetItemStyleMaterialLink`	48	35,447,945
`EVENT_UNIT_ATTRIBUTE_VISUAL_UPDATED`	48	4,802,926
`EVENT_UNIT_ATTRIBUTE_VISUAL_REMOVED`	47	4,774,322
`GetItemTrait`	46	26,249,434
`GetMailItemInfo`	46	11,883,645
`EVENT_QUEST_ADVANCED`	46	14,891,174
`GetActionBindingInfo`	46	17,960,073
`GetPlayerStat`	46	6,511,276
`GetItemInstanceId`	46	15,720,618
`EVENT_QUEST_COMPLETE_DIALOG`	45	18,893,495
`GetAbilityDescription`	45	31,633,620
`IsItemJunk`	45	9,352,285
`GetPlayerChampionPointsEarned`	45	6,045,620
`EVENT_SMITHING_TRAIT_RESEARCH_STARTED`	44	10,799,066
`GetCollectibleIdForHouse`	44	11,040,586
`GetDate`	43	24,289,243
`GetFriendCharacterInfo`	43	5,435,172
`SendMail`	43	1,227,149
`GetLatency`	42	26,273,576
`GetJournalQuestNumSteps`	42	20,865,811
`DeleteMail`	42	11,717,017
`GetItemLinkDisplayQuality`	42	26,812,145
`GetAbilityCastInfo`	42	29,618,893
`GetActiveHotbarCategory`	42	24,278,641
`GetCurrentQuickslot`	42	15,250,587
`GetSlotCooldownInfo`	42	14,103,318
`IsUnitInGroupSupportRange`	42	9,759,262
`IsESOPlusSubscriber`	42	6,439,349
`EVENT_STEALTH_STATE_CHANGED`	42	5,289,001
`GetAllianceName`	42	4,981,617
`GetParentZoneId`	41	34,974,861
`EndInteraction`	41	25,332,105
`GetChatterOption`	41	17,629,977
`FastTravelToNode`	41	11,888,729
`GetSecondsSinceMidnight`	41	7,793,734
`EVENT_GUILD_MEMBER_ADDED`	41	12,642,011
`EVENT_GUILD_MEMBER_PLAYER_STATUS_CHANGED`	41	4,975,396
`GetStoreItemLink`	41	13,541,683
`SetItemIsJunk`	41	2,590,554
`GetAchievementCategoryInfo`	40	41,427,165
`IsInImperialCity`	40	22,001,538
`GetJournalQuestNumConditions`	40	27,965,374
`DestroyItem`	40	14,400,887
`EVENT_QUEST_CONDITION_COUNTER_CHANGED`	40	22,725,898
`GetChampionSkillName`	40	10,986,398
`EVENT_FRIEND_PLAYER_STATUS_CHANGED`	40	15,432,011
`GetActionIndicesFromName`	40	12,516,632
`IsItemLinkBound`	40	5,107,096
`EVENT_LEADER_UPDATE`	40	5,115,991
`EVENT_MAIL_SEND_SUCCESS`	40	2,773,353
`IsReticleHidden`	40	840,144
`GetJournalQuestType`	39	29,556,041
`ApplyTemplateToControl`	39	15,526,286
`GetSlotType`	39	23,546,999
`EVENT_SMITHING_TRAIT_RESEARCH_COMPLETED`	39	10,777,069
`GetCampaignName`	39	9,032,636
`EVENT_LEVEL_UPDATE`	39	7,922,434
`EVENT_CURRENCY_UPDATE`	39	1,631,658
`IsUnitAttackable`	39	1,019,732
`GetCollectibleIcon`	38	16,201,788
`EVENT_GROUP_MEMBER_ROLE_CHANGED`	38	19,742,724
`GetBuybackItemLink`	38	19,592,503
`GetNonCombatBonus`	38	10,274,584
`IsGameCameraUIModeActive`	37	13,294,753
`IsItemBound`	37	4,619,220
`GetMailAttachmentInfo`	37	3,413,874
`GetUnitClass`	37	2,401,773
`EVENT_MAIL_SEND_FAILED`	37	1,189,638
`GetJournalQuestRepeatType`	36	16,944,504
`GetCurrentCampaignId`	36	6,819,070
`HashString`	36	9,825,189
`IsItemSetCollectionPieceUnlocked`	36	5,420,155
`FormatIntegerWithDigitGrouping`	36	4,349,002
`GetChargeInfoForItem`	36	5,328,362
`IsBlockActive`	36	2,439,845
`SetMapToPlayerLocation`	35	52,623,385
`PingMap`	35	36,699,316
`GetKeepName`	35	16,004,837
`GetNumPointsSpentOnChampionSkill`	35	7,109,216
`IsUnitSwimming`	35	5,230,915
`GetPlayerLocationName`	35	6,880,962
`EVENT_GUILD_MEMBER_REMOVED`	35	13,907,696
`EVENT_ACTION_SLOT_STATE_UPDATED`	35	6,612,582
`EVENT_UNIT_CREATED`	35	4,195,914
`GetUnitReaction`	35	2,505,571
`EVENT_MAIL_READABLE`	34	12,586,728
`GetPlayerActiveZoneName`	34	6,449,426
`IsValidQuestIndex`	34	17,382,430
`GetItemLinkBindType`	34	14,428,972
`EVENT_OPEN_FENCE`	34	4,577,494
`QueueMoneyAttachment`	34	4,028,997
`IsItemLinkCrafted`	34	4,675,674
`GetUnitRace`	34	2,449,961
`GetUIMousePosition`	33	18,117,626
`IsPlayerActivated`	33	9,523,292
`EVENT_CLIENT_INTERACT_RESULT`	33	17,354,969
`GetChatCategoryColor`	33	15,555,271
`BitAnd`	33	19,639,605
`EVENT_TRADING_HOUSE_RESPONSE_RECEIVED`	33	21,010,756
`GetZoneIndex`	33	11,331,297
`GetCollectibleCategoryType`	33	7,551,295
`GetUnitAvARank`	33	4,568,842
`RequestOpenMailbox`	33	1,238,338
`PlayEmoteByIndex`	33	1,393,883
`GroupInviteByName`	33	730,679
`GetNumFastTravelNodes`	32	38,967,236
`GetRecipeInfo`	32	20,598,570
`EVENT_EXPERIENCE_UPDATE`	32	15,956,825
`EVENT_ACTION_SLOTS_ACTIVE_HOTBAR_UPDATED`	32	9,413,580
`GetAbilityCost`	32	13,305,500
`IsInCyrodiil`	32	7,772,654
`EVENT_BROADCAST`	32	12,011,409
`GetNumSkillTypes`	32	12,849,420
`EVENT_ZONE_UPDATE`	32	3,779,886
`GetCompanionName`	32	4,384,846
`GetUnitXP`	32	5,567,657
`GetEmoteSlashNameByIndex`	32	2,820,172
`EVENT_BANKED_MONEY_UPDATE`	32	2,916,257
`IsUnitDeadOrReincarnating`	32	1,229,227
`GetItemArmorType`	31	13,428,459
`GetSkillAbilityId`	31	19,317,203
`GetClassName`	31	14,475,987
`GetFenceSellTransactionInfo`	31	8,633,618
`GetActiveCompanionDefId`	31	5,262,228
`GetSelectedGuildBankId`	31	3,502,431
`GetItemLinkTraitType`	31	11,395,872
`GetNumChampionXPInChampionPoint`	31	5,706,313
`DoesItemHaveDurability`	31	3,885,662
`GetNextMailId`	31	1,655,215
`GetLoreBookInfo`	30	38,404,233
`GetPOIMapInfo`	30	24,954,190
`GetSlotName`	30	12,100,199
`EVENT_ARMORY_BUILD_RESTORE_RESPONSE`	30	13,014,986
`GetSlotItemLink`	30	7,809,482
`GetUnitAttributeVisualizerEffectInfo`	30	7,511,139
`GetCollectibleIdFromType`	30	5,804,045
`HasActiveCompanion`	30	6,731,614
`IsItemLinkRecipeKnown`	30	9,090,631
`SelectChatterOption`	30	3,182,511
`GetSetting_Bool`	30	4,309,830
`EVENT_ACTIVE_QUEST_TOOL_CHANGED`	30	4,438,526
`GetAttachedItemInfo`	30	2,814,151
`ChargeItemWithSoulGem`	30	5,088,978
`GetAssignedCampaignId`	30	2,509,135
`EVENT_CONVERSATION_UPDATED`	30	1,298,654
`EVENT_ASSIGNED_CAMPAIGN_CHANGED`	30	3,885,768
`EVENT_SHOW_BOOK`	29	30,052,293
`GetCurrentHouseOwner`	29	13,644,367
`GetRecipeResultItemLink`	29	25,143,977
`GetAbilityProgressionXPInfoFromAbilityId`	29	12,417,382
`GetMaxSimultaneousSmithingResearch`	29	12,714,531
`GetRecipeListInfo`	29	14,028,243
`EVENT_SCREEN_RESIZED`	29	8,133,014
`EVENT_ARTIFACT_CONTROL_STATE`	29	3,496,099
`GroupLeave`	29	618,618
`IsPlayerInGroup`	29	673,014
`GetQuestName`	28	29,520,205
`GetJournalQuestStepInfo`	28	12,265,079
`CloseMailbox`	28	10,398,924
`GetCurrencyName`	28	11,719,042
`GetItemCreatorName`	28	17,563,870
`EVENT_ACTIVITY_FINDER_STATUS_UPDATE`	28	9,960,511
`ClearCursor`	28	17,527,037
`GetPlayerActiveSubzoneName`	28	12,474,642
`EVENT_UNIT_DESTROYED`	28	3,492,292
`GetAchievementSubCategoryInfo`	28	5,968,188

Events (27)

Symbol	Addons using it	Their combined downloads
`EVENT_REASON_SOFTWARE`	251	26,392,264
`EVENT_RETICLE_TARGET_CHANGED`	137	25,722,882
`EVENT_PLAYER_DEACTIVATED`	98	55,142,441
`EVENT_OPEN_STORE`	88	19,978,887
`EVENT_CLOSE_BANK`	87	22,732,980
`EVENT_PLAYER_DEAD`	82	9,436,303
`EVENT_GROUP_UPDATE`	81	42,271,645
`EVENT_PLAYER_ALIVE`	68	10,380,403
`EVENT_CHATTER_END`	60	12,856,447
`EVENT_MAIL_OPEN_MAILBOX`	53	16,774,710
`EVENT_CLOSE_GUILD_BANK`	52	13,220,718
`EVENT_QUEST_OFFERED`	47	18,908,300
`EVENT_CLOSE_STORE`	46	10,271,825
`EVENT_ACTION_SLOTS_ALL_HOTBARS_UPDATED`	42	11,317,549
`EVENT_OPEN_TRADING_HOUSE`	41	14,321,254
`EVENT_CLOSE_TRADING_HOUSE`	40	17,263,058
`EVENT_BEGIN_LOCKPICK`	39	13,337,154
`EVENT_ACTION_UPDATE_COOLDOWNS`	38	16,262,976
`EVENT_MAIL_CLOSE_MAILBOX`	38	6,392,841
`EVENT_OPEN_GUILD_BANK`	38	5,624,426
`EVENT_INVENTORY_FULL_UPDATE`	35	15,590,641
`EVENT_ABILITY_LIST_CHANGED`	34	4,367,978
`EVENT_LOOT_UPDATED`	32	13,143,060
`EVENT_BEGIN_SIEGE_CONTROL`	32	19,922,845
`EVENT_GAME_CAMERA_UI_MODE_CHANGED`	32	12,099,861
`EVENT_ACHIEVEMENTS_UPDATED`	32	3,673,289
`EVENT_LOOT_CLOSED`	30	14,667,912