FiveM API Reference
Public-facing REST endpoints for FiveMFiveMA multiplayer modification framework for Grand Theft Auto V, enabling custom multiplayer servers with modding support./RedM services. No auth required unless noted.
User
| Endpoint | Method | URL |
|---|---|---|
| User Session | GET | https://forum.cfx.re/session/current.json |
| Information | GET | https://forum.cfx.re/u/{username}.json |
| CSRF Session | GET | https://forum.cfx.re/session/csrf.json |
| Username Check | GET | https://forum.cfx.re/u/check_username.json?username={username} |
| Email Check | GET | https://forum.cfx.re/u/check_email.json?email={email} |
| Policy User | GET | https://policy-live.fivem.net/api/getUserInfo/{id} |
| Send Email | POST | https://forum.cfx.re/u/action/send_activation_email |
Send Email — Headers
{
"Cfx-Entitlement-Ticket": "{ownership ticket}",
"x-requested-with": "XMLHttpRequest",
"discourse-present": "true",
"x-csrf-token": "{csrf token}"
}
Body: username={your_username}
FiveM
| Endpoint | Method | URL |
|---|---|---|
| Main Information | GET | http://{ip:port}/info.json |
| Dynamic Information | GET | http://{ip:port}/dynamic.json |
| Player Information | GET | http://{ip:port}/players.json |
| Server List Info | GET | https://servers-frontend.fivem.net/api/servers/single/{address} |
| All Server Data | GET | https://servers-frontend.fivem.net/api/servers/streamRedir |
| Top Server (Country) | GET | https://servers-frontend.fivem.net/api/servers/top/{language} |
| Upvote Information | GET | https://servers-frontend.fivem.net/api/upvote/ (auth headers required) |
| Player Playtime | GET | https://lambda.fivem.net/api/ticket/playtimes/{ip:port}?identifiers[]={identifier} |
| Promotions | GET | https://runtime.fivem.net/promotions_targeting.json |
| CnL | GET | https://lambda.fivem.net |
| CnL Heartbeat | GET | https://cnl-hb-live.fivem.net |
| Top Server | GET | https://runtime.fivem.net/pins.json |
| Sentry Login | GET | https://sentry.fivem.net/auth/login |
| Build Change Log | GET | https://changelogs-live.fivem.net/api/changelog/versions/{buildversion} |
| NUI Blacklist | GET | https://runtime.fivem.net/nui-blacklist.json |
| Players Count | GET | https://runtime.fivem.net/counts.json |
| Players Count (FiveMFiveMA multiplayer modification framework for Grand Theft Auto V, enabling custom multiplayer servers with modding support.) | GET | https://static.cfx.re/runtime/counts.json |
| Players Count (RedM) | GET | https://static.cfx.re/runtime/counts_rdr3.json |
| Tweet | GET | https://runtime.fivem.net/tweets.json |
| Artifact Data | GET | https://changelogs-live.fivem.net/api/changelog/versions/win32/server |
| Loading Screen | GET | https://runtime.fivem.net/loadscreen/spotlight-2/WebGL-GTA |
| Pool Size Limits (FiveMFiveMA multiplayer modification framework for Grand Theft Auto V, enabling custom multiplayer servers with modding support.) | GET | https://content.cfx.re/mirrors/client/pool-size-limits/fivem.json |
| Pool Size Limits (RedM) | GET | https://content.cfx.re/mirrors/client/pool-size-limits/redm.json |
| Native (FiveMFiveMA multiplayer modification framework for Grand Theft Auto V, enabling custom multiplayer servers with modding support.) | GET | https://static.cfx.re/natives/natives.lua |
| Native (RedM) | GET | https://static.cfx.re/natives/natives_rdr3.lua |