Skip to main content

Host API System

The R5R Tracker uses a secure API system to authenticate game servers and attribute stats to the correct Verified Host.

Host API Key

Your Host API Key is the master credential that links your game servers to your verified account.
  • Generation: You can generate or regenerate your key in the Control Panel > Settings.
  • Usage: This key must be placed in your server’s platform/r5rdev_config.json file.
  • Security: Never share this key. If compromised, anyone can upload fake stats to your servers.
{
    "host_api_key": "YOUR_GENERATED_KEY_HERE"
}

Server Identifiers

To distinguish between multiple servers running under the same host account, the system uses Server Identifiers.

1. Registering Identifiers

In the Control Panel, go to the Servers tab. Here you can define identifiers for your instances (e.g., na-west-1, eu-central-pro, 1v1-arena).

2. Configuring the Server

On your game server, you must set the identifier ConVar or config setting to match one of your registered identifiers. This allows the tracker to know exactly which of your servers is reporting data.

Data Endpoints

The tracker system primarily communicates with two endpoints:

Player Stats Ingest

  • Endpoint: /api/stats8.php
  • Function: Receives real-time player statistics (kills, damage, weapon usage) at the end of rounds or matches.
  • Auth: Requires valid HOST_API_KEY and Verified Host status.

Match Logs Ingest

  • Endpoint: /api/tracker.php
  • Function: Uploads compressed match logs for archival and replay analysis.
  • Auth: IP Whitelisted or Key Authenticated.

Discord Webhooks

If enabled, your server can send events to a Discord Webhook.
  • Endpoint: /api/playercount.php
  • Configuration: Set stats_discord_webhook_player_count "1" in playlists_r5_patch.txt.
  • Behavior: Sends “Player Joined”, “Player Left”, and “Match Ended” events to your configured webhook URL.