Venice Unleashed

Venice Unleashed endpoints are available at https://api.bflist.io/v2/vu/.

Missing servers

We're currently unable to query all Venice Unleashed servers due to issues with how some servers are hosted.

If you'd like to get your server listed, please see our FAQ entry on getting your server added.

Live stats

Retrieve the current number of active players and servers, along with data coverage. coverage refers to the percentage (0.0-1.0) of known servers for which we currently have data available via the API.

Low coverage

Due to the issues mentioned above, our coverage for Venice Unleashed is currently very low. If you need accurate player numbers, fetch historical records from census-api.cetteup.com instead. census uses the Venice Unleashed server list to collect accurate readings every 10 minutes.

Request

GET /livestats HTTP/1.1

Response

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

{
  "servers": 30,
  "players": 7,
  "coverage": 0.58
}

List servers

Get a paginated list of currently available servers.

Request

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": "0dc46531b1f24006895ab75eff1bb102",
      "ip": "124.221.143.18",
      "port": 25200,
      "name": "VU Genshin Impact Server +qq qun:725062034",
      "numPlayers": 32,
      "maxPlayers": 69,
      "map": "XP4_FD",
      "mapLabel": "Markaz Monolith",
      "gameType": "ConquestSmall",
      "roundsPlayed": 0,
      "roundsTotal": 1,
      "targetScore": 0,
      "password": false,
      "uptime": 53566,
      "roundTime": 1738,
      "region": "EU",
      "country": "NL",
      "pingSite": "iad",
      "version": "20079",
      "teams": [
        {
          "tickets": 411.668091
        },
        {
          "tickets": 181.611679
        }
      ],
      "players": [
        {
          "name": "AUVzuiyouzi",
          "team": 1,
          "squad": 1,
          "squadLabel": "Alpha",
          "kills": 17,
          "deaths": 7,
          "score": 3059,
          "ping": 12
        },
        // more players
      ]
    },
    // more servers
  ],
  "cursor": "4c379877-b1f0-4534-8a4c-627d9503de9e",
  "hasMore": true
}

Get a server

Retrieve a single server.

Request

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": "30d77c27c80f4a118a4f1f2121890b11",
  "ip": "139.226.28.246",
  "port": 25201,
  "name": "Springfield Bakery Alpha Testing (PVP Allowed,Q:459893774)",
  "numPlayers": 64,
  "maxPlayers": 127,
  "map": "MP_018",
  "mapLabel": "Kharg Island",
  "gameType": "RushLarge",
  "roundsPlayed": 0,
  "roundsTotal": 1,
  "targetScore": 0,
  "password": false,
  "uptime": 551978,
  "roundTime": 1482,
  "region": "EU",
  "country": "NL",
  "pingSite": "iad",
  "version": "20079",
  "teams": [
    {
      "tickets": 160
    },
    {
      "tickets": 2945
    }
  ],
  "players": [
    {
      "name": "JOZOULE",
      "team": 1,
      "squad": 1,
      "squadLabel": "Alpha",
      "kills": 0,
      "deaths": 0,
      "score": 0,
      "ping": 54
    },
    // more players
  ]
}

Get a player

Fetch a currently active player.

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.

Request

GET /players/{name} 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

{
  "name": "AUVzuiyouzi",
  "team": 1,
  "squad": 1,
  "squadLabel": "Alpha",
  "kills": 20,
  "deaths": 7,
  "score": 3439,
  "ping": 21
}

Get a player's current server

Get the server a player is currently playing on.

Request

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": "0b1538167f7d4c028876b2058bd26719",
  "ip": "222.152.82.46",
  "port": 25200,
  "name": "CPeno's BF3 server",
  "numPlayers": 53,
  "maxPlayers": 103,
  "map": "MP_012",
  "mapLabel": "Operation Firestorm",
  "gameType": "ConquestLarge",
  "roundsPlayed": 0,
  "roundsTotal": 1,
  "targetScore": 0,
  "password": false,
  "uptime": 45724,
  "roundTime": 448,
  "region": "EU",
  "country": "NL",
  "pingSite": "iad",
  "version": "20079",
  "teams": [
    {
      "tickets": 469.86615
    },
    {
      "tickets": 503.005371
    }
  ],
  "players": [
    {
      "name": "CLM",
      "team": 2,
      "squad": 8,
      "squadLabel": "Hotel",
      "kills": 0,
      "deaths": 3,
      "score": 0,
      "ping": 275
    },
    // more players
  ]
}