Battlefield Vietnam

Battlefield Vietnam endpoints are available at https://api.bflist.io/v2/bfvietnam/.

Live stats

Retrieve the current number of active players and servers.

GET /livestats HTTP/1.1

Response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "servers": 10,
  "players": 10
}

List servers

Get a paginated list of currently available servers.

Since servers for older Battlefield games do not have a guid, one is generated using the server's ip and port. The generated guid is bflist-specific and neither known to nor returned by the server.

If a server's current mod is supported by joinme.click, the joinLink-property will contain a URL to directly join the server. In environments which do not allow custom URL protocols (e.g. Discord, Twitch chat), use joinLinkWeb instead. Users will be directed to the joinme.click website and can join from there.

Note: Both properties will be null for servers running mods not supported by joinme.click.

GET /servers HTTP/1.1

Parameters

param	Description
cursor	Pagination cursor (optional, required if after is set)
after	Pagination marker (optional)
perPage	Number of items per page (optional, default: 50)

Response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "servers": [
    {
      "guid": "4630c00-dd24cb-277b6c0-1944c00",
      "ip": "158.69.118.94",
      "port": 15567,
      "queryPort": 23000,
      "name": "-[HELLO]- Bfv | V1.21",
      "numPlayers": 17,
      "maxPlayers": 52,
      "mapName": "IA DRANG VALLEY",
      "password": false,
      "gameType": "conquest",
      "gameVersion": "v1.21",
      "gameMode": "openplaying",
      "dedicated": 2,
      "status": 4,
      "gameId": "bfvietnam",
      "mapId": "BFVietnam",
      "anticheat": false,
      "autobalance": false,
      "timelimit": 0,
      "roundsPerMap": 1,
      "spawnWaveTime": 5,
      "spawnDelay": 4,
      "gameStartDelay": 15,
      "soldierFriendlyFire": 0,
      "vehicleFriendlyFire": 0,
      "ticketRatio": 100,
      "allowNoseCam": true,
      "externalView": true,
      "freeCamera": false,
      "usTeamRatio": 1,
      "nvaTeamRatio": 1,
      "bandwidthChokeLimit": 0,
      "nameTagDistance": 100,
      "nameTagDistanceScope": 300,
      "kickback": 0,
      "kickbackOnSplash": 0,
      "soldierFriendlyFireOnSplash": 0,
      "vehicleFriendlyFireOnSplash": 0,
      "cpu": 3699,
      "botSkill": 0,
      "reservedSlots": 0,
      "spectatorsAllowed": true,
      "spectatorVoting": false,
      "spectatorSwitchTime": 120,
      "activeMods": "",
      "allActiveMods": "bfvietnam",
      "gameIdName": "BFVietnam",
      "joinLink": "bfvietnam://158.69.118.94:15567",
      "joinLinkWeb": "https://joinme.click/g/bfvietnam/158.69.118.94:15567",
      "teams": [
        {
          "index": 1,
          "label": "Red",
          "tickets": 277
        },
        {
          "index": 2,
          "label": "Blue",
          "tickets": 216
        },
        {
          "index": 3,
          "label": "Spectators"
        }
      ],
      "players": [
        {
          "name": "LawsomeGunner",
          "score": 10,
          "kills": 4,
          "deaths": 13,
          "ping": 33,
          "team": 1,
          "teamLabel": "Red"
        },
        // more players
      ]
    },
    // more servers
  ],
  "cursor": "4c379877-b1f0-4534-8a4c-627d9503de9e",
  "hasMore": true
}

Get a server

Retrieve a single server.

GET /servers/{ip}:{port} HTTP/1.1

Parameters

param	Description
ip	Server's (public) IP address
port	Server's game port

Response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "guid": "1b6b0b0-4c7768b-19cc37b-14c0b6b",
  "ip": "98.165.95.85",
  "port": 15567,
  "queryPort": 23000,
  "name": "Arsenal BG:42 BG:V EoD PoE",
  "numPlayers": 1,
  "maxPlayers": 52,
  "mapName": "A Bridge Too Far",
  "password": false,
  "gameType": "coop",
  "gameVersion": "v1.21",
  "gameMode": "openplaying",
  "dedicated": 1,
  "status": 4,
  "gameId": "poe",
  "mapId": "PoE",
  "anticheat": false,
  "autobalance": false,
  "timelimit": 32,
  "roundsPerMap": 1,
  "spawnWaveTime": 5,
  "spawnDelay": 4,
  "gameStartDelay": 18,
  "soldierFriendlyFire": 50,
  "vehicleFriendlyFire": 50,
  "ticketRatio": 500,
  "allowNoseCam": true,
  "externalView": true,
  "freeCamera": false,
  "usTeamRatio": 2,
  "nvaTeamRatio": 3,
  "bandwidthChokeLimit": 0,
  "nameTagDistance": 100,
  "nameTagDistanceScope": 200,
  "kickback": 50,
  "kickbackOnSplash": 50,
  "soldierFriendlyFireOnSplash": 50,
  "vehicleFriendlyFireOnSplash": 50,
  "cpu": 2833,
  "botSkill": 95,
  "reservedSlots": 0,
  "spectatorsAllowed": true,
  "spectatorVoting": false,
  "spectatorSwitchTime": 60,
  "activeMods": ",",
  "allActiveMods": "battlegroup42, bfv_arsenal, bfv_ww2mod, bfv_ww2mod_x, bfvietnam, bg-vietnam, eod, poe",
  "gameIdName": "PoE",
  "joinLink": null,
  "joinLinkWeb": null,
  "teams": [
    {
      "index": 1,
      "label": "Red",
      "tickets": 1423
    },
    {
      "index": 2,
      "label": "Blue",
      "tickets": 1171
    },
    {
      "index": 3,
      "label": "Spectators"
    }
  ],
  "players": [
    {
      "name": "Merkin",
      "score": 4,
      "kills": 4,
      "deaths": 0,
      "ping": 0,
      "team": 2,
      "teamLabel": "Blue"
    },
    // more players
  ]
}

Get a player

Fetch a currently active player.

GET /players/{name} HTTP/1.1

Player Name Conflicts

In rare cases, two active players may have exactly the same name. To avoid inconsistencies, the API responds with a 409 Conflict error if a request refers to a player name that isn't unique.

Parameters

param	Description
name	Player's url-encoded name/nick (without any tag/prefix)

Response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "name": "LoNe WoLf[Ger]",
  "score": 18,
  "kills": 14,
  "deaths": 1,
  "ping": 107,
  "team": 2,
  "teamLabel": "Blue"
}

Get a player's current server

Get the server a player is currently playing on.

GET /players/{name}/server HTTP/1.1

Parameters

param	Description
name	Player's url-encoded name/nick (without any tag/prefix)

Response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "guid": "17b9255-111e4c8-4c7f11a-684c5ad",
  "ip": "91.77.165.193",
  "port": 15567,
  "queryPort": 23009,
  "name": "+1: Vietnam",
  "numPlayers": 2,
  "maxPlayers": 32,
  "mapName": "OPERATION FLAMING DART",
  "password": false,
  "gameType": "coop",
  "gameVersion": "v1.21",
  "gameMode": "openplaying",
  "dedicated": 2,
  "status": 4,
  "gameId": "bfvietnam",
  "mapId": "BFVietnam",
  "anticheat": false,
  "autobalance": true,
  "timelimit": 30,
  "roundsPerMap": 1,
  "spawnWaveTime": 10,
  "spawnDelay": 3,
  "gameStartDelay": 30,
  "soldierFriendlyFire": 25,
  "vehicleFriendlyFire": 25,
  "ticketRatio": 225,
  "allowNoseCam": true,
  "externalView": true,
  "freeCamera": false,
  "usTeamRatio": 99,
  "nvaTeamRatio": 101,
  "bandwidthChokeLimit": 0,
  "nameTagDistance": 240,
  "nameTagDistanceScope": 360,
  "kickback": 400,
  "kickbackOnSplash": 400,
  "soldierFriendlyFireOnSplash": 25,
  "vehicleFriendlyFireOnSplash": 25,
  "cpu": 800,
  "botSkill": 75,
  "reservedSlots": 0,
  "spectatorsAllowed": true,
  "spectatorVoting": false,
  "spectatorSwitchTime": 120,
  "activeMods": "",
  "allActiveMods": "bfvietnam",
  "gameIdName": "BFVietnam",
  "joinLink": "bfvietnam://91.77.165.193:15567",
  "joinLinkWeb": "https://joinme.click/g/bfvietnam/91.77.165.193:15567",
  "teams": [
    {
      "index": 1,
      "label": "Red",
      "tickets": 289
    },
    {
      "index": 2,
      "label": "Blue",
      "tickets": 310
    },
    {
      "index": 3,
      "label": "Spectators"
    }
  ],
  "players": [
    {
      "name": "Telrin",
      "score": 32,
      "kills": 25,
      "deaths": 7,
      "ping": 3,
      "team": 2,
      "teamLabel": "Blue"
    },
    // more players
  ]
}