Home
Twitter Github

GameAPIs

Battlefield 3 Documentation

Parameters

Required Parameter Type Description Default Value
True IP String Server's IP address or domain None
False Port Integer The port of which the game server is running on. 25200

Status Query

Single Server

GET https://use.gameapis.net/bf3/query/status/{IP}:{PORT}
{
    "status": true,
    "hostname": "{IP}",
    "port": {PORT},
    "cached": false
}

Multiple Servers

GET https://use.gameapis.net/bf3/query/status/{IP}:{PORT},{IP2}:{PORT2}
{
    "{IP}:{PORT}": {
        "status": true,
        "hostname": "{IP}",
        "port": {PORT},
        "cached": false
    },
    "{IP2}:{PORT2}": {
        "status": true,
        "hostname": "{IP2}",
        "port": {PORT2},
        "cached": false
    }
}

Players Query

Single Server

GET https://use.gameapis.net/bf3/query/players/{IP}:{PORT}
{
    "status": true,
    "hostname": "{IP}",
    "port": {PORT},
    "players": {
        "online": 1,
        "max": 100,
        "list": [
            {
                "name": "Va11eronFairp1ay",
                "guid": "",
                "teamId": "1",
                "squadId": "1",
                "kills": "6",
                "deaths": "8",
                "score": "3080",
                "rank": "143",
                "ping": "44"
            }
        ]
    },
    "cached": false
}

Multiple Servers

GET https://use.gameapis.net/bf3/query/players/{IP}:{PORT},{IP2}:{PORT2}
{
    "{IP}:{PORT}": {
        "status": true,
        "hostname": "{IP}",
        "port": {PORT},
        "players": {
            "online": 0,
            "max": 100,
            "list": null
        },
        "cached": false
    },
    "{IP2}:{PORT2}": {
        "status": true,
        "hostname": "{IP2}",
        "port": {PORT2},
        "players": {
            "online": 1,
            "max": 100,
            "list": [
                {
                    "name": "Va11eronFairp1ay",
                    "guid": "",
                    "teamId": "1",
                    "squadId": "1",
                    "kills": "6",
                    "deaths": "8",
                    "score": "3080",
                    "rank": "143",
                    "ping": "44"
                }
            ]
        },
        "cached": false
    }
}

Info Query

Single Server

GET https://use.gameapis.net/bf3/query/info/{IP}:{PORT}
{
    "status": true,
    "hostname": "{IP}",
    "port": {PORT},
    "name": "BF3 Server",
    "version": "3065862",
    "players": {
        "online": 1,
        "max": 100,
        "list": [
            {
                "name": "Va11eronFairp1ay",
                "guid": "",
                "teamId": "1",
                "squadId": "1",
                "kills": "6",
                "deaths": "8",
                "score": "3080",
                "rank": "143",
                "ping": "44"
            }
        ]
    },
    "cached": false
}

Multiple Servers

GET https://use.gameapis.net/bf3/query/info/{IP}:{PORT},{IP2}:{PORT2}
{
    "{IP}:{PORT}": {
        "status": true,
        "hostname": "{IP}",
        "port": {PORT},
        "name": "BF3 Server",
        "version": "3065862",
        "players": {
            "online": 0,
            "max": 100,
            "list": null
        },
        "cached": false
    },
    "{IP2}:{PORT2}": {
        "status": true,
        "hostname": "{IP2}",
        "port": {PORT2},
        "name": "BF3 Server",
        "version": "3065862",
        "players": {
            "online": 1,
            "max": 100,
            "list": [
                {
                    "name": "Va11eronFairp1ay",
                    "guid": "",
                    "teamId": "1",
                    "squadId": "1",
                    "kills": "6",
                    "deaths": "8",
                    "score": "3080",
                    "rank": "143",
                    "ping": "44"
                }
            ]
        },
        "cached": false
    }
}