Skip to main content
GET
/
v2
/
server
Fetch server information
curl --request GET \
  --url https://api.erlc.gg/v2/server \
  --header 'server-key: <api-key>'
{
  "Name": "API Test",
  "OwnerId": 123,
  "CoOwnerIds": [
    123
  ],
  "CurrentPlayers": 123,
  "MaxPlayers": 123,
  "JoinKey": "APIServer",
  "AccVerifiedReq": "Disabled / Email / Phone/ID",
  "TeamBalance": true,
  "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",
      "WantedStars": 0
    }
  ],
  "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"
    }
  ],
  "Queue": [
    123
  ],
  "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"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://apidocs.erlc.gg/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
server-key
string
header
required

REQUIRED ON ALL REQUESTS. Get your server key at https://erlc.link/sk

Query Parameters

​
Players
boolean

Include player list in response

Example:

true

​
Staff
boolean

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

Example:

true

​
JoinLogs
boolean

Include join logs in response

Example:

true

​
Queue
boolean

Include queue data in response

Example:

true

​
KillLogs
boolean

Include kill logs in response

Example:

true

​
CommandLogs
boolean

Include command logs in response

Example:

true

​
ModCalls
boolean

Include moderator call logs in response

Example:

true

​
EmergencyCalls
boolean

Include emergency call logs in response

Example:

true

​
Vehicles
boolean

Include vehicle list in response

Example:

true

Response

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

​
Name
string
required
Example:

"API Test"

​
OwnerId
integer
required
​
CoOwnerIds
integer[]
required
​
CurrentPlayers
integer
required
​
MaxPlayers
integer
required
​
JoinKey
string
required
Example:

"APIServer"

​
AccVerifiedReq
string
required
Example:

"Disabled / Email / Phone/ID"

​
TeamBalance
boolean
required
​
Players
object[]

Only included when Players=true query parameter is provided

​
Staff
object

Only included when Staff=true query parameter is provided

​
JoinLogs
object[]

Only included when JoinLogs=true query parameter is provided

​
Queue
integer[]

Only included when Queue=true query parameter is provided

​
KillLogs
object[]

Only included when KillLogs=true query parameter is provided

​
CommandLogs
object[]

Only included when CommandLogs=true query parameter is provided

​
ModCalls
object[]

Only included when ModCalls=true query parameter is provided

​
EmergencyCalls
object[]

Only included when EmergencyCalls=true query parameter is provided

Example:
[
  {
    "Team": "Police",
    "Caller": 168691872,
    "Players": [],
    "Position": [-654.6, 666.5],
    "StartedAt": 1774216563,
    "CallNumber": 400,
    "Description": "stg",
    "PositionDescriptor": "sdfsdfsdf"
  }
]
​
Vehicles
object[]

Only included when Vehicles=true query parameter is provided