Git Product home page Git Product logo

fivem-server-stats-api's Introduction

Server Information API

This API provides server information for a specific server code without exposing the server IP or requiring direct access to the server's JSON data. It pulls data from the FiveM server frontend API (https://servers-frontend.fivem.net/api/servers/single/) and avoid CORS issues.

Usage

To retrieve server information, make a GET request to the API endpoint with the server code as a path parameter. For example:

GET /{server_code}

Replace {server_code} with the actual server FiveM CFX code you want to retrieve information for.

Response

The API will respond with the server information in JSON format. If the server code is a vanity code (e.g., "test" or "example"), it will be mapped to the corresponding server code before fetching the data.

Example response:

{
    "connect": "https://cfx.re/join/server_code",
    "endpoint": "server_code",
    "online": true,
    "hostname": "Test Server",
    "players": {
        "count": 75,
        "self-reported": 75,
        "list": [
            ...
        ]
    },
    "slots": 256,
    "private": false,
    "last-seen": "..."
}

GET /original/{server_code}

Example response:

{
    "connect": "https://cfx.re/join/server_code",
    "endpoint": "server_code",
    "online": true,
    "hostname": "Test Server",
    "players": {
        "count": 75,
        "self-reported": 75,
        "list": [
            ...
        ]
    },
    "original": {
        // Original API response
    }
    "slots": 256,
    "private": false,
    "last-seen": "..."
}

Build From Source

  1. Clone the repository: git clone https://github.com/akatiggerx04/fivem-servers-stats-api

  2. Install modules: go mod tidy

  3. Build: go build main.go handlers.go

Deployment

The server runs at port 7747.

Credits

by @akatiggerx04 :)

fivem-server-stats-api's People

Contributors

akatiggerx04 avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.