Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

A Python wrapper for the FIVEM API.

Project description

FiveM-Api

Small package in order to interact with FiveM API

How-to install :

pip install fivem

How-to use : Here is an example to display the number of players online on a server.

import fivem;

server = fivem.getServer("88.214.59.183:30120")
print(server.players)
fivem.getServer(ipServer:port)

(default port is 30120)

It returns a Server Class with those attributes:

players: [{
        "endpoint"; string,
        "id": int, // The server ID og the player
        "identifiers": array, // Identifiers of the player
        "name": string, // Username's player
        "ping": int, // Le ping
    }],
info: {
    "enhancedHostSupport": boolean,
    "icon": string, // Icon of the server (Base64)
    "resources": array, // All started resources
    "server": string, // FXServer's version (string format)
    "vars": { // Some convars defined in server.cfg
        "sv_enhancedHostSupport": boolean,
        "sv_lan": boolean,
        "sv_licenseKeyToken": string,
        "sv_maxClients": int,
        "sv_scriptHookAllowed": boolean,
        "sv_hostname": string,
    },
    "version": int, // FXServer's version (numeric format)
}
name: string // Name of the server


This API is loosely based on the node.js Fivem API.

Project details


Release history Release notifications

This version

0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for fivem, version 0.1
Filename, size File type Python version Upload date Hashes
Filename, size fivem-0.1-py3-none-any.whl (3.1 kB) File type Wheel Python version py3 Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page