API Reference

Ingest Endpoint

The primary endpoint used by the DayZ mod to send gameplay events to Rankly.gg.

POST/api/ingest

Accepts a JSON array of events from the DayZ mod. Events are queued for processing and stats are updated asynchronously.

Required Headers

X-API-KeyYour server API key (RNKLY-XXXX-XXXX-XXXX-XXXX)

Content-Typeapplication/json

Event Types

The mod sends a variety of event types, each representing a different in-game action:

killPlayer or zombie kill

deathPlayer death

connectPlayer joined server

disconnectPlayer left server

positionPlayer position update

itemItem pickup or consume

buildStructure placed/destroyed

vehicleVehicle event

socialHandcuff, revive, etc.

medicalBandage, splint, blood

harvestAnimal skinning, fishing

craftRecipe crafting

exposureContamination, temperature

Request Body

Send a JSON array of event objects. Each event must include a type field. Additional fields vary by event type.

POST /api/ingest
X-API-Key: RNKLY-XXXX-XXXX-XXXX-XXXX
Content-Type: application/json

[
  {
    "type": "kill",
    "killerSteamId": "76561198012345678",
    "killerName": "PlayerOne",
    "victimSteamId": "76561198087654321",
    "victimName": "PlayerTwo",
    "weapon": "M4A1",
    "distance": 142.5,
    "bodypart": "head",
    "timestamp": "2026-03-14T18:30:00Z"
  },
  {
    "type": "connect",
    "steamId": "76561198012345678",
    "playerName": "PlayerOne",
    "timestamp": "2026-03-14T18:00:00Z"
  }
]

Response

A successful response indicates how many events were accepted for processing:

{
  "success": true,
  "processed": 2
}

Error Responses

400Invalid request body or malformed JSON

401Missing or invalid API key

429Rate limit exceeded

500Internal server error