Fivem Server Api
This JavaScript package connects to any FiveM server using its CFX.re URL or direct IP:PORT and retrieves live server data through simple async methods. It returns server status, player counts, full player lists, resource names, and configuration flags such as OneSync and game build.
Designed for external tools, the library supports both CommonJS and ESM imports with optional timeout and error message settings. Server owners can integrate it into monitoring dashboards, Discord bots, or websites that need accurate FiveM server metrics without running additional resources on the game server.
- Fetch player count and complete player list
- Check server status, OneSync, and Steam ticket requirements
- Retrieve server name, description, resources, tags, and locale
- Access game build, license token, and script hook settings