Every FiveM server and resource, over HTTP

Network totals: players, servers, capacity, crawl coverage, and 24-hour change. The cheapest call, and the one most bots want.

curl -H "Authorization: Bearer $HEARTBEAT_KEY" \
  https://heartbeat.re/api/v1/stats

{
  "data": {
    "players": 186308,
    "servers": 34951,
    "populatedServers": 8599,
    "slotsFilledPercent": 5.93,
    "distinctResources": 1254808,
    "coverage": { "serversCrawled": 46798, "serversTotal": 34951, "percent": 36.2 },
    "change": { "playersPercent": 0.7, "serversPercent": 0.1 }
  }
}

Network totals over time, one point per census (roughly every five minutes).

curl -H "Authorization: Bearer $HEARTBEAT_KEY" \
  "https://heartbeat.re/api/v1/stats/history?hours=48"

List and filter servers. Combine filters freely, this is how you answer questions like 'the busiest German roleplay servers running more than 100 resources'.

curl -H "Authorization: Bearer $HEARTBEAT_KEY" \
  "https://heartbeat.re/api/v1/servers?country=DE&tag=roleplay&minPlayers=50&limit=10"

{
  "data": [
    {
      "joinId": "j4r9zmk",
      "name": "KROWN",
      "players": 1846,
      "maxPlayers": 2048,
      "country": "TH",
      "countryName": "Thailand",
      "tags": ["roleplay", "economy"],
      "resourceCount": 218,
      "connectUrl": "https://cfx.re/join/j4r9zmk"
    }
  ],
  "meta": { "total": 412, "limit": 10, "offset": 0, "hasMore": true }
}

A single server by its Cfx join id, the code in a cfx.re/join link.

curl -H "Authorization: Bearer $HEARTBEAT_KEY" \
  "https://heartbeat.re/api/v1/servers/j4r9zmk?history=true"

Every resource a server loads, each annotated with how widely it is used across the network, so you can tell its bespoke code from the community standards.

curl -H "Authorization: Bearer $HEARTBEAT_KEY" \
  https://heartbeat.re/api/v1/servers/j4r9zmk/resources

{
  "data": {
    "joinId": "j4r9zmk",
    "count": 218,
    "resources": [
      { "name": "ox_lib",   "servers": 3299, "playerReach": 108736, "playersPerServer": 33 },
      { "name": "sd-mdt",   "servers": 12,   "playerReach": 840,    "playersPerServer": 70 }
    ]
  }
}

The resource leaderboard. Ranked by player reach, total live players across every server running it, rather than raw installs, because a script on 400 empty servers reaches nobody.

curl -H "Authorization: Bearer $HEARTBEAT_KEY" \
  "https://heartbeat.re/api/v1/resources?sort=reach&limit=5"

{
  "data": [
    { "name": "hardcap",   "servers": 7123, "playerReach": 134810, "populatedServers": 4957 },
    { "name": "oxmysql",   "servers": 6902, "playerReach": 129440, "populatedServers": 4801 }
  ],
  "meta": { "total": 417858, "limit": 5, "offset": 0, "hasMore": true }
}

One resource, with optional weekly adoption history. URL-encode names containing slashes or spaces.

curl -H "Authorization: Bearer $HEARTBEAT_KEY" \
  "https://heartbeat.re/api/v1/resources/ox_lib?history=true"

Servers known to run a resource, busiest first. Useful for 'who actually uses this script, and how big are they?'

curl -H "Authorization: Bearer $HEARTBEAT_KEY" \
  "https://heartbeat.re/api/v1/resources/ox_lib/servers?limit=20"

Players and servers grouped by the region each server advertises, with each country's share of the network.

curl -H "Authorization: Bearer $HEARTBEAT_KEY" \
  "https://heartbeat.re/api/v1/regions?limit=10"

One call across servers and resources, built for autocomplete and Discord slash commands.

curl -H "Authorization: Bearer $HEARTBEAT_KEY" \
  "https://heartbeat.re/api/v1/search?q=police"

Framework market share across crawled servers, ESX, QBCore, Qbox, vRP and standalone, with players-per-server. Pass resources=true for each framework's own top-resource leaderboard, which is a very different list from the global one.

curl -H "Authorization: Bearer $HEARTBEAT_KEY"   "https://heartbeat.re/api/v1/frameworks?resources=true"

{
  "data": [
    { "id": "esx",  "label": "ESX",  "servers": 4897, "players": 46797, "playersPerServer": 9.6 },
    { "id": "vrp",  "label": "vRP",  "servers": 1049, "players": 25959, "playersPerServer": 24.7 }
  ]
}

Co-occurrence for a resource: what ships alongside it, what is distinctively paired with it, and what it appears to depend on. Dependencies are inferred from one-way co-installation, not read from a manifest.

curl -H "Authorization: Bearer $HEARTBEAT_KEY"   https://heartbeat.re/api/v1/resources/esx_policejob/related

{
  "data": {
    "resource": "esx_policejob",
    "shipsWith":    [ { "resource": "esx_menu_default", "confidence": 0.97, "lift": 3.4 } ],
    "distinctive":  [ { "resource": "esx_society",      "confidence": 0.95, "lift": 3.6 } ],
    "inferredDependencies": [
      { "resource": "esx_license",   "confidence": 0.92, "lift": 3.80 },
      { "resource": "esx_datastore", "confidence": 0.92, "lift": 3.67 }
    ]
  }
}

Rising and falling resources. Ranked by change in share of crawled servers, not raw install count, while the crawler is still sweeping, absolute counts climb for everything at once, so a raw-count ranking would measure our coverage rather than actual adoption.

curl -H "Authorization: Bearer $HEARTBEAT_KEY"   "https://heartbeat.re/api/v1/resources/momentum?hours=48"

Servers with the most overlapping resource sets (Jaccard similarity), plus the resources those peers run that this server doesn't, the practical version of 'what is everyone like me installing?'

curl -H "Authorization: Bearer $HEARTBEAT_KEY"   https://heartbeat.re/api/v1/servers/j4r9zmk/similar

Register a Discord webhook alert on a server or resource. Only https Discord webhook URLs are accepted, and alerts fire on threshold crossings with a 15-minute cooldown. Requires an instance running the ingest worker, a read-only snapshot refuses rather than accepting a watch it can never deliver.

curl -X POST https://heartbeat.re/api/v1/watches   -H "Authorization: Bearer $HEARTBEAT_KEY"   -H "Content-Type: application/json"   -d '{
    "kind": "server",
    "target": "j4r9zmk",
    "condition": "below",
    "threshold": 100,
    "webhookUrl": "https://discord.com/api/webhooks/…"
  }'

Create a key programmatically. No authentication required, limited to 5 per hour per IP. The key is returned once and never again.

curl -X POST https://heartbeat.re/api/v1/keys \
  -H "Content-Type: application/json" \
  -d '{"name":"my-discord-bot"}'

{
  "data": {
    "key": "hb_live_eyJ2IjoxLCJpZCI6…",
    "keyId": "a1b2c3d4e5f6",
    "tier": "free",
    "rateLimitPerMinute": 60,
    "notice": "Store this key now, it is not recoverable and is shown only once."
  }
}