Skip to content
/ cfx-api Public
forked from pablo-1610/cfx-api

Cfx.re API to fetch Fivem servers data

License

Notifications You must be signed in to change notification settings

a9ex/cfx-api

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Cfx.re JavaScript API

A package that helps you interacting with the Cfx.re API to fetch FiveM servers

How to install

npm i cfx-api

How to use:

const cfx = require("cfx-api");

const server = cfx.retrieveFive("v45z95").then(server => { // Replace v45z95 with a server id
    console.log(server.hostname)

    console.log(server.ownerProfileUrl)

    server.players.forEach(player => {
         console.log(player.name)
    })
})

About

Cfx.re API to fetch Fivem servers data

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%