API Docs

The following is an example response:

{
  "ip": "51.81.33.11",
  "port": 28500,
  "geoip": {
    "name": "United States",
    "code": "US",
    "flag": "🇺🇸"
  },
  "debug": {
    "sent": 6011,
    "recv": 4214,
    "sentBytes": 48088,
    "recvBytes": 583129,
    "lastRequest": 1732172907875,
    "ping": 153
  },
  "ts": 1732172878,
  "password": false,
  "usgnonly": false,
  "fow": false,
  "friendlyfire": false,
  "bots": 2,
  "lua": true,
  "forcelight": true,
  "name": "............RP............",
  "map": "fun_roleplay",
  "players": 5,
  "maxplayers": 28,
  "gamemode": 1,
  "recoil": false,
  "offscreendamage": false,
  "hasdownloads": true,
  "playerlist": [
    {
      "id": 1,
      "name": "[b]Starfish",
      "team": 1,
      "score": 0,
      "deaths": 484
    },
    {
      "id": 2,
      "name": "[b]Executor",
      "team": 2,
      "score": 0,
      "deaths": 0
    },
    {
      "id": 3,
      "name": "._.",
      "team": 2,
      "score": 484,
      "deaths": 0
    },
    {
      "id": 4,
      "name": "Iulian",
      "team": 2,
      "score": 0,
      "deaths": 0
    },
    {
      "id": 5,
      "name": "Player",
      "team": 0,
      "score": 0,
      "deaths": 0
    }
  ]
}

The parameters are defined as follows:

• ip: The server's IP address.
• port: The server's port number.
• geoip:
  • name: Country name.
  • code: Country code.
  • flag: Emoji flag representation.
• debug:
  • sent: Number of packets sent.
  • recv: Number of packets received.
  • sentBytes: Total bytes sent.
  • recvBytes: Total bytes received.
  • lastRequest: Timestamp of the last sent request.
  • ping: Current server ping in milliseconds.
• ts: Timestamp of the last received request.
• password: Indicates if the server requires a password (true/false).
• usgnonly: Indicates if only U.S.G.N players are allowed (true/false).
• fow: Indicates if the server has field of view restrictions (true/false).
• friendlyfire: Indicates if friendly fire is enabled (true/false).
• bots: Number of bots currently in the game.
• lua: Indicates if Lua scripting is enabled (true/false).
• forcelight: Indicates if forced lighting is enabled (true/false).
• name: Name of the server.
• map: Current map being played.
• players: Number of players currently in the game.
• maxplayers: Maximum number of players allowed on the server.
• gamemode: Current game mode (0 for standard, etc.).
• recoil: Indicates if recoil is enabled (true/false).
• offscreendamage: Indicates if offscreen damage is enabled (true/false).
• hasdownloads: Indicates if the server has downloadable content (true/false).
• playerlist: An array of current players on the server, with each player containing:
  • id: Unique player identifier.
  • name: Player's name.
  • team: Team identifier (0 for spectators, 1/2 for teams).
  • score: Player's score.
  • deaths: Number of deaths.