Documentation
Using CFXR
Everything you need to know about looking up FiveM server information — supported inputs, returned data and how resolution works.
Supported input formats
CFXR normalises all of the following input formats to a bare server ID before resolving.
| Input | Description |
|---|---|
| b578o4 | Bare server ID |
| join/b578o4 | join/ prefix |
| cfx.re/join/b578o4 | cfx.re domain |
| https://cfx.re/join/b578o4 | Full join URL |
| fivem://connect/b578o4 | FiveM connect URL |
Input matching is case-insensitive —
B578O4 and b578o4 resolve to the same server.Data shown for each server
| Field | Details |
|---|---|
| Server name | Display name and project name from the server config |
| Game type | Gamemode label reported by the server |
| Players / Max players | Current online count and configured slot limit |
| Tags | Self-reported server tags for discovery |
| Endpoint | Raw endpoint string (host:port or IP:port) |
| IP Address | Resolved IPv4/IPv6 address for the primary endpoint |
| ASN | Autonomous System Number of the hosting network |
| ISP | Internet service provider or hosting company name |
| Region | Geographic region derived from IP geolocation |
| Country | Country with flag emoji derived from IP geolocation |
| Resources | Full list of resources loaded by the server, searchable |
| Player list | Names, IDs and pings of currently connected players |
| Raw API response | Complete unprocessed JSON from the CFX API |
How CFXR works
CFXR queries the public servers/single/<id> endpoint of the CFX API, then resolves any hostnames in the server endpoint to IP addresses via DNS. IP geolocation (ASN, ISP, region, country) is fetched from a chain of public IP data APIs.
Results are cached server-side for 60 seconds on success, so subsequent lookups of the same server ID are served instantly from cache with no external network calls.
Programmatic access
All resolution is available via the HTTP API at POST /api/resolve. See the API reference for the full request/response schema.