Skip to content

A JavaScript API for interacting with the FiveM API.

License

Notifications You must be signed in to change notification settings

vinicius7199/fivem-api

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

FiveM

API for getting FiveM server info & status.

Installation

Install Package: npm i fivem

Usage

Examples

See if server is online (json)

const FiveM = require("fivem") // Import the npm package.
const srv = new FiveM.Server('IP:PORT') // Set the IP with port.
 
srv.getServerStatus().then(data => console.log(data)) // Get & log the data!

//if online returns json {online: true}
// if offline returns json {online: false, url: x, method: x}

Get Player Count (in numbers)

const FiveM = require("fivem") // Import the npm package.
const srv = new FiveM.Server('IP:PORT') // Set the IP with port.
 
srv.getPlayers().then(data => console.log(data)) // Get & log the data!

Get all Resources

const FiveM = require("fivem") // Import the npm package.
const srv = new FiveM.Server('IP:PORT') // Set the IP with port.
 
srv.getResources().then(data => console.log(data)) // Get & log the data!

ALL FUNCTION REQUESTS

  • getPlayers - (number)
  • getMaxPlayers - (number)
  • getResources - (string/array)
  • getTags - (string)
  • getServer - (string)
  • getOnesync - (boolean)
  • getLocale - (string)
  • getGamename - (string)
  • getEnhancedHostSupport - (boolean)
  • getlicenseKeyToken - (string)
  • getScriptHookAllowed - (boolean)

About

A JavaScript API for interacting with the FiveM API.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%