{"repo":"pablo-1610/cfx-api","free":true,"listed":false,"github":"https://github.com/pablo-1610/cfx-api","clone":"git clone https://github.com/pablo-1610/cfx-api.git","description":"Fully typed Node.js/TypeScript library to read the Cfx.re, FiveM and RedM server list, single servers, featured servers, icons, status and direct game server data.","language":"TypeScript","stars":52,"topics":["api","fivem","fivem-api","node","cfx-api","redm","api-client","cfx","cfx-re","nodejs"],"license":"MIT","category":"api-integrations-sdks","readme_excerpt":"cfx-api The fastest way to read the Cfx.re, FiveM and RedM server list from Node.js. cfx-api lets you query the public Cfx.re infrastructure with a clean, fully typed API: the complete server list (decoded from the binary streamRedir feed), a single server, featured servers, server icons, the Cfx.re status page, and a game server's own endpoints. Table of contents - Features - Installation - Quick start - API - servers - status - Aliases - The CitizenServer model - License Features - 🌍 Full server list decoded from the protobuf streamRedir feed, with client-side filters. - 🔎 Single server lookup with the complete payload (players, resources, owner, variables…). - ⭐ Featured servers as shown on the official server list. - 🖼️ Server icons as a Buffer or a ready-to-use URL. - 🛰️ Direct game server queries ( info.json , dynamic.json , players.json ). - 📊 Cfx.re status and unresolved incidents. - 🧩 Fully typed , zero configuration, works in JavaScript and TypeScript. Installation Quick start API The library exposes two namespaces, servers and status . Standalone fetch functions are also available as aliases. servers servers.all(filters?) Fetches the full public server list and decodes it. Returns an array of CitizenServer . Filter Type Description --- --- --- locale string Keep only servers using this locale gametype string Keep only servers with this game type mapname string Keep only servers with this map name minPlayers number Minimum connected players maxPlayers number M","default_branch":null,"files":null,"tree":[],"storefront":"/r/pablo-1610","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/pablo-1610/cfx-api/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}