Home
Twitter Github

GameAPIs

Garry's Mod 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. 27015

Status Query

Single Server

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

Multiple Servers

GET https://use.gameapis.net/gmod/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/gmod/query/players/{IP}:{PORT}
{
    "status": true,
    "hostname": "{IP}",
    "port": {PORT},
    "players": {
        "online": 110,
        "max": 128
    },
    "cached": false
}

Multiple Servers

GET https://use.gameapis.net/gmod/query/players/{IP}:{PORT},{IP2}:{PORT2}
{
    "{IP}:{PORT}": {
        "status": true,
        "hostname": "{IP}",
        "port": {PORT},
        "players": {
            "online": 110,
            "max": 128
        },
        "cached": false
    },
    "{IP2}:{PORT2}": {
        "status": true,
        "hostname": "{IP2}",
        "port": {PORT2},
        "players": {
            "online": 53,
            "max": 128
        },
        "cached": false
    }
}

Info Query

Single Server

GET https://use.gameapis.net/gmod/query/info/{IP}:{PORT}
{
    "status": true,
    "hostname": "{IP}",
    "port": {PORT},
    "name": "gmod server",
    "map": "gm_site19",
    "vac_secured": true,
    "password_protected": false,
    "join": "steam://connect/{IP}:{PORT}/",
    "version": "16.12.01",
    "protocol": 17,
    "players": {
        "online": 53,
        "max": 128
    },
    "cached": false
}

Multiple Servers

GET https://use.gameapis.net/gmod/query/info/{IP}:{PORT},{IP2}:{PORT2}
{
    "{IP}:{PORT}": {
        "status": true,
        "hostname": "{IP}",
        "port": {PORT},
        "name": "gmod server",
        "map": "rp_bangclaw",
        "vac_secured": true,
        "password_protected": false,
        "join": "steam://connect/{IP}:{PORT}/",
        "version": "16.12.01",
        "protocol": 17,
        "players": {
            "online": 110,
            "max": 128
        },
        "cached": false
    },
    "{IP2}:{PORT2}": {
        "status": true,
        "hostname": "{IP}",
        "port": {PORT},
        "name": "gmod server",
        "map": "gm_site19",
        "vac_secured": true,
        "password_protected": false,
        "join": "steam://connect/{IP}:{PORT}/",
        "version": "16.12.01",
        "protocol": 17,
        "players": {
            "online": 53,
            "max": 128
        },
        "cached": false
    }
}