Developers

API reference

Every public export, event and console command of Apex in one place.

Replace ApexAC with your Apex resource folder name if you renamed it. See Integration overview for timing and safety notes.

Server exports#

Export	Parameters	Returns	Description
`allow`	`(playerId, kind, ms)`	boolean	Temporarily ignore detections for a legit action. Details
`apexAllowSpawn`	`(playerId, model, ms)`	—	Whitelist one model spawn for a player. Details
`apexSrvExempt`	`(playerId, detection, ms)`	—	Spawn detections only (`antiVehicleSpawn`, `antiPedSpawn`, `antiObject`).
`SetAuthorizedWeapons`	`(playerId, list)`	—	Replace the allowed weapons. Details
`AddAuthorizedWeapon`	`(playerId, weapon)`	—	Add one allowed weapon.
`RemoveAuthorizedWeapon`	`(playerId, weapon)`	—	Remove one allowed weapon.
`apexDetActionFor`	`(detection)`	`'ban'`/`'kick'`/`'warn'`/`nil`	Current action of a detection.
`Verify`	`(playerId, token, eventName, opts)`	boolean	Verify a protected event. Details
`Flag`	`(playerId, reason, detail)`	—	Manual flag (`antiEventSpoof`).
`GetSessionInfo`	`(playerId)`	table / nil	Session details of a player.

Client exports#

Export	Parameters	Description
`apexExempt`	`(detection, ms)`	Local exemption for client checks (safe zones). Details
`Trigger`	`(eventName, ...)`	Fire a protected server event (adds the token).

Server events (server-only)#

Event	Arguments	Description
`apex:allow`	`playerId, kind, ms`	Same as the `allow` export.
`apex:det:allowSpawn`	`playerId, model, ms`	Same as `apexAllowSpawn`.
`apex:det:srvExempt`	`playerId, detection, ms`	Same as `apexSrvExempt`.
`apex:ext:flag`	`playerId, detection, detail`	Report a player to Apex.

Client events (local only)#

Event	Arguments	Description
`apex:det:exempt`	`detection, ms`	Same as the `apexExempt` export.

Internal events

Apex uses many internal events (apexac:*, apex:det:*, apex:esp:*…) between its own client and server. They are not an API and change between versions. Triggering Apex's admin events as a non-admin is detected as cheating (antiTriggerClientEvent).

Server console commands#

Run these in the server console / txAdmin Live Console.

Command	Description
`apexset`	Shows the settings received from your dashboard (whitelists, VPN, Discord requirement…).
`apexwg`	WeaponGuard status per player: detected inventory, held weapon, allowed weapons.
`apexspawn`	Which resources spawn vehicles, and for how many players.

In-game commands#

Command	Who	Description
`/apex`	Staff	Opens the in-game panel.
Hold middle mouse	Staff	Inspect the entity you aim at (rebind in Settings → Key Bindings → FiveM → Apex: Inspect entity).

Convars#

Convar	Description
`apex_key`	Your licence key (alternative to the `apex.key` file).