Skip to content

Battlefield Vietnam

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

Live stats#

Get the number of currently active players and servers in Battlefield Vietnam.

GET /livestats

Response

200 OK

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

Get a page from the list of servers#

Per default, we send 50 servers per page. You can set a custom page size betweeen 20 and 100 via an optional perPage query parameter.

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 the joinme.click launcher, the joinLink-property will contain a URL to directly trigger the launcher. 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 trigger the launcher from there. Note: Both properties will be null for servers running mods not supported by joinme.click.

GET /servers/:page

Response

200 OK
X-Total-Pages: 1

[
    {
        "guid": "4630c00-dd24cb-277b6c0-1944c00",
        "ip": "158.69.118.94",
        "port": 15567,
        "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
]

Get a server's details#

GET /servers/:ip::port

Note: You can also access each property individually. For example, GET /servers/:ip::port/name will return only the server's name as plain text. Complex properties (teams, players) are returned as JSON. So, GET /servers/:ip::port/players will return a JSON array of players on the server.

Response

200 OK
{
    "guid": "1b6b0b0-4c7768b-19cc37b-14c0b6b",
    "ip": "98.165.95.85",
    "port": 15567,
    "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"
        }
    ]
}

Get a player's details#

GET /players/:name

Note: You can also access each property individually. For example, GET /players/:name/score will return only the players's current score as plain text.

Response

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

Get a player's current server's details#

GET /players/:name/server

Please see the section on getting an individual server's details, as this endpoint's features and response structure are identical.