API reference

Base URL: https://fiveban.xyz

All responses are JSON. Times are ISO 8601 in UTC.

Authentication

Two endpoint families:

Public (/api/...) — IP rate-limited (~30/h), reduced data.
Authenticated (/api/v1/...) — Bearer token, full data.

Send your API key as:

Authorization: Bearer <your_api_key>

API keys are issued from your dashboard once you have a Pro or Business plan.

`GET /api/v1/check?q=<input>`

Look up a player. Accepts any of the same identifiers as the web form: Discord ID, FiveM license hash, Steam ID, or Discord username.

Response (200)

{
  "found": true,
  "status": "confirmed",
  "discord_id": "1234567890",
  "username": "Cheater#1337",
  "ban_reason": "EAC bypass",
  "ban_date": "2026-04-01T12:34:56.000Z",
  "alts_count": 3,
  "warnings_count": 0,
  "your_plan": "pro"
}

| Field | Type | Notes | | --- | --- | --- | | found | bool | false if no record exists. | | status | string | confirmed / suspicious / clean / unknown. | | alts_count | int | Other Discord IDs sharing a license hash. Pro+ only, 0 for free. | | warnings_count | int | Active warnings (!w). | | your_plan | string | Plan tier of the API key. |

Errors

401 unauthorized — missing or invalid Authorization header.
400 missing_query — q parameter is required.
429 rate_limited — only relevant on /api/check (public).

`GET /api/v1/stats`

Returns aggregate FiveBan stats — same numbers shown on the homepage.

{
  "total_blacklisted": 12345,
  "confirmed_bans": 9876,
  "suspicious": 543,
  "protected_servers": 28,
  "checks_today": 1234,
  "checks_total": 998877,
  "bans_last_24h": 5,
  "bans_last_7d": 31,
  "bans_per_day_7d": [3, 5, 4, 6, 5, 4, 4],
  "bans_sparkline": "▃▅▄▆▅▄▄"
}

Cached for 60 seconds, no auth required.

`GET /api/v1/resource-version`

Returns the latest FiveM resource version (used by the resource itself for update notifications).

{
  "version": "1.4.2",
  "download_url": "https://github.com/.../releases/latest",
  "disabled": false
}

`GET /api/health`

{ "status": "ok", "db": "ok", "version": "0.1.0", "now": "..." }

Returns 503 if the database is unavailable. Suitable for uptime monitors.