Sign in

v1

latestOpenAPI 3.0.12026-07-26209.6 KB

Fetch server information

Returns server status data. Additional fields can be included by setting query parameters to 'true'. All query parameters are optional.

get/v2/server

Query parameters

Playersboolean
Example:true

Include player list in response

Staffboolean
Example:true

Include staff list (Admins, Mods, Helpers) in response

JoinLogsboolean
Example:true

Include join logs in response

Queueboolean
Example:true

Include queue data in response

KillLogsboolean
Example:true

Include kill logs in response

CommandLogsboolean
Example:true

Include command logs in response

ModCallsboolean
Example:true

Include moderator call logs in response

EmergencyCallsboolean
Example:true

Include emergency call logs in response

Vehiclesboolean
Example:true

Include vehicle list in response

Headers

Authorizationstring

OPTIONAL. ONLY provide this header if you are creating a public app (used in many unique servers). Register your app at https://apidocs.erlc.gg/creating-public-applications.

Response

Requested data. Optional fields only included when query=true.

Namestring required
OwnerIdinteger required
CoOwnerIdsinteger[] required
CurrentPlayersinteger required
MaxPlayersinteger required
JoinKeystring required
AccVerifiedReqstring required
TeamBalanceboolean required
Queueinteger[]

Only included when Queue=true query parameter is provided

Example response

{
  "Name": "API Test",
  "JoinKey": "APIServer",
  "AccVerifiedReq": "Disabled / Email / Phone/ID",
  "Players": [
    {
      "Team": "Sheriff",
      "Player": "PlayerName:Id",
      "Callsign": "5D-550",
      "Location": {
        "LocationX": 1084.965,
        "LocationZ": 2302.28,
        "PostalCode": "218",
        "StreetName": "Park Street",
        "BuildingNumber": "2083"
      },
      "Permission": "Normal / Server Administrator / Server Owner / Server Moderator"
    }
  ],
  "Staff": {
    "Admins": {
      "54249787": "Black_Hallow",
      "77573259": "sli_ckk"
    },
    "Mods": {
      "2": "JohnDoe",
      "3": "JaneDoe"
    },
    "Helpers": {
      "168691872": "Flat_bird"
    }
  },
  "JoinLogs": [
    {
      "Join": true,
      "Timestamp": 1704614400,
      "Player": "PlayerName:Id"
    }
  ],
  "KillLogs": [
    {
      "Killed": "PlayerName:Id",
      "Timestamp": 1704614400,
      "Killer": "PlayerName:Id"
    }
  ],
  "CommandLogs": [
    {
      "Player": "PlayerName:Id",
      "Timestamp": 1704614400,
      "Command": ":h"
    }
  ],
  "ModCalls": [
    {
      "Caller": "PlayerName:Id",
      "Moderator": "PlayerName:Id",
      "Timestamp": 1704614400
    }
  ],
  "EmergencyCalls": [
    {
      "Team": "Police",
      "Caller": 168691872,
      "Players": [],
      "Position": [
        -654.6,
        666.5
      ],
      "StartedAt": 1774216563,
      "CallNumber": 400,
      "Description": "stg",
      "PositionDescriptor": "sdfsdfsdf"
    }
  ],
  "Vehicles": [
    {
      "Name": "Redline Fire Engine",
      "Owner": "Shawnyg",
      "Plate": "ABC-123",
      "Texture": "Livery Name",
      "ColorHex": "#ff4444",
      "ColorName": "Super Red"
    }
  ]
}
All 2 operations