Developers

Build on your server data

The Citadel Data API lets your own tools — killfeed bots, leaderboard sites, Discord integrations — read your DayZ servers over a documented REST API. Everything the Live Ops Console shows, your code can read too.

Quick start

  1. Sign in and open Account → API Keys. Create a key — the ctk_… value is shown once.
  2. Send it as a bearer token on every request. A key reads only your account's servers.
  3. Import the OpenAPI spec into Postman, Insomnia, or any client to explore every endpoint.
# list your servers
curl https://api.citadel-hub.com/api/v1/data/servers \
-H "Authorization: Bearer ctk_your_key_here"

What you can read

Six read endpoints today, all backed by the same telemetry the console runs on. Live player coordinates are intentionally not exposed — Citadel doesn't ship a radar API.

Servers & status

List your servers and read live status — player count, FPS, uptime, online state.

Leaderboards

Ranked players by points, K/D, or kills — the same data that powers the console leaderboard.

Killfeed

PvP kills newest-first with weapon, distance, hit zone, and headshot flag. Cursor-paginated.

Bans

Your server's ban list, filterable to active or expired.

Trust lookup

The public, no-key trust score for any player — SteamID, Citadel ID, or Discord.

Scoped keys

A key reads only the servers its account owns. Mint and revoke keys in your dashboard.

Two APIs, one platform

The Data API reads your own servers with a customer key. The public Trust API looks up any player's cross-community trust score with no key at all — build a killfeed that flags known cheaters in the same request.