FiveVault
DashboardServersPlayersResourcesTrendsReportsExplorerAPIWidgets
FiveVault Telemetry API v1Rate Limit: 500 req/min

Developer API Documentation

Programmatic REST access to live FiveM and RedM server metrics, player sightings, script adoption statistics, and timeseries historical telemetry.

Get API Key in Settings
Authentication

Pass your secret key either in the X-API-Key request header or as a Bearer authorization token.

X-API-Key: fs_live_a1b2c3d4...
500 Requests / Minute

Every API key receives a generous sliding window quota of 500 requests per minute. Quota status is returned in every response header:

X-RateLimit-Limit: 500
X-RateLimit-Remaining: 498
Base Endpoint

All API endpoints return standard JSON payloads. HTTPS is enforced in production.

https://servers.fivevault.net/api/v1

Available Endpoints

GET/stats/summary
Global Concurrency & Summary

Returns real-time network-wide player concurrency, total active servers, peak concurrency in the last 24h, and median capacity.

Query Parameters
FieldTypeRequiredDescription
gamestringOptional"fivem" (default) or "redm"
Example Request (curl)
curl -X GET "https://servers.fivevault.net/api/v1/stats/summary?game=fivem" \
  -H "X-API-Key: fv_live_your_api_key_here"
Example JSON Response (200 OK)
{
  "game": "fivem",
  "playersNow": 207682,
  "peakPlayers": 221874,
  "totalServers": 33512,
  "avgFill": 48.2,
  "medianFill": 41.0
}
GET/servers
List Tracked Servers

Returns a paginated list of all public Cfx.re servers sorted by live players, community rank, or name.

Query Parameters
FieldTypeRequiredDescription
gamestringOptional"fivem" (default) or "redm"
sortstringOptional"players_desc" (default), "players_asc", "rank_asc", "name_asc"
pagenumberOptionalPage number (default 1)
pageSizenumberOptionalItems per page (max 100, default 25)
searchstringOptionalSearch term for server hostname or cfx code
localestringOptionalFilter by country or locale code (e.g. "pl", "fr", "en-US")
Example Request (curl)
curl -X GET "https://servers.fivevault.net/api/v1/servers?game=fivem&sort=players_desc&pageSize=2" \
  -H "X-API-Key: fv_live_your_api_key_here"
Example JSON Response (200 OK)
{
  "items": [
    {
      "id": 142,
      "cfx_code": "xll9rkm",
      "game": "fivem",
      "hostname": "Narco City 🚀 Roleplay mit Niveau | 18+ | IC Einreise",
      "current_clients": 1840,
      "sv_maxclients": 2048,
      "current_rank": 1,
      "prev_rank": 1,
      "locale": "de-DE",
      "tags": "roleplay,custom,drugs,economy",
      "icon_version": 12891238,
      "last_seen_at": "2026-09-17T21:15:00.000Z"
    }
  ],
  "total": 33512,
  "page": 1,
  "pageSize": 2,
  "totalPages": 16756
}
GET/servers/:code
Get Single Server Telemetry

Returns real-time telemetry for a specific server by its Cfx Join Code (e.g. xll9rkm). Includes live players list, installed resource manifests, and raw FXServer variables.

Query Parameters
FieldTypeRequiredDescription
codestringRequiredUnique Cfx code (e.g. "xll9rkm")
Example Request (curl)
curl -X GET "https://servers.fivevault.net/api/v1/servers/xll9rkm" \
  -H "X-API-Key: fv_live_your_api_key_here"
Example JSON Response (200 OK)
{
  "code": "xll9rkm",
  "game": "fivem",
  "hostname": "Narco City 🚀 Roleplay mit Niveau | 18+",
  "clients": 1840,
  "sv_maxclients": 2048,
  "current_rank": 1,
  "prev_rank": 1,
  "isOnline": true,
  "locale": "de-DE",
  "tags": "roleplay,custom,economy",
  "iconVersion": 12891238,
  "serverVersion": "v1.0.0.7290 linux",
  "resources": [
    "oxmysql",
    "ox_lib",
    "ox_inventory",
    "pma-voice"
  ],
  "players": [
    {
      "id": 1,
      "name": "Alex_Vance",
      "ping": 24,
      "identifiers": ["license:8a9b2c..."]
    }
  ]
}
GET/servers/explore
Multi-Facet Server Explorer

Filter servers simultaneously across player thresholds, rank boundaries, specific script dependencies, country locales, and tags.

Query Parameters
FieldTypeRequiredDescription
gamestringOptional"fivem", "redm", or "all"
minPlayersnumberOptionalMinimum online players (e.g. 100)
maxPlayersnumberOptionalMaximum online players
resourcestringOptionalInstalled script requirement (e.g. "ox_inventory")
tagstringOptionalTag requirement (e.g. "roleplay")
localestringOptionalCountry code (e.g. "pl")
Example Request (curl)
curl -X GET "https://servers.fivevault.net/api/v1/servers/explore?minPlayers=50&resource=ox_inventory&locale=pl" \
  -H "X-API-Key: fv_live_your_api_key_here"
Example JSON Response (200 OK)
{
  "items": [
    {
      "cfx_code": "4yk51z",
      "hostname": "OsloRP ✦ Polski Serwer Roleplay ✦ Dzienne Nagrody",
      "current_clients": 514,
      "sv_maxclients": 750,
      "current_rank": 14,
      "locale": "pl-PL",
      "tags": "roleplay,custom,pl,oslorp"
    }
  ],
  "total": 48,
  "page": 1,
  "pageSize": 25,
  "totalPages": 2
}
GET/resources
Resource & Script Census

Returns the ecosystem-wide adoption ranking of scripts and resources across all 35,000+ servers.

Query Parameters
FieldTypeRequiredDescription
gamestringOptional"fivem" (default) or "redm"
searchstringOptionalScript name filter (e.g. "ox_")
pageSizenumberOptionalItems per page (max 100)
Example Request (curl)
curl -X GET "https://servers.fivevault.net/api/v1/resources?search=ox_&pageSize=3" \
  -H "X-API-Key: fv_live_your_api_key_here"
Example JSON Response (200 OK)
{
  "items": [
    {
      "id": 1,
      "name": "oxmysql",
      "game": "fivem",
      "current_server_count": 30071,
      "prev_server_count": 29840,
      "current_rank": 1,
      "prev_rank": 1
    },
    {
      "id": 3,
      "name": "ox_lib",
      "game": "fivem",
      "current_server_count": 27797,
      "prev_server_count": 27410,
      "current_rank": 3,
      "prev_rank": 3
    }
  ],
  "total": 6,
  "totalActiveServers": 33512,
  "page": 1,
  "pageSize": 3
}
FiveVault Telemetry•Realtime ecosystem tracking for Cfx.re platform
AboutContactDaily ReportsExplorerWidgetsAPI DocsTerms of ServicePrivacy Policy