Home
Twitter Github

GameAPIs

ARK: Survival Evolved 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. 7777

Status Query

Single Server

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

Multiple Servers

GET https://use.gameapis.net/ark/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/ark/query/players/{IP}:{PORT}
{
    "status": true,
    "hostname": "{IP}",
    "port": {PORT},
    "players": {
        "online": 1,
        "max": 100,
        "list": [
            {
                "name": "TheEggMan",
                "score": 0,
                "time": {
                    "seconds": 4104.6127929688,
                    "minutes": 68.410213216146,
                    "hours": 1.1401702202691
                }
            }
        ]
    },
    "cached": false
}

Multiple Servers

GET https://use.gameapis.net/ark/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": "TheEggMan",
                    "score": 0,
                    "time": {
                        "seconds": 4104.6127929688,
                        "minutes": 68.410213216146,
                        "hours": 1.1401702202691
                    }
                }
            ]
        },
        "cached": false
    }
}

Info Query

Single Server

GET https://use.gameapis.net/ark/query/info/{IP}:{PORT}
{
    "status": true,
    "hostname": "{IP}",
    "port": {PORT},
    "name": "Ark Server",
    "map": "Ragnarok",
    "secure": true,
    "password_protected": false,
    "join": "steam://connect/{IP}:{PORT}/",
    "version": "1.0.0.0",
    "protocol": 17,
    "players": {
        "online": 1,
        "max": 100,
        "list": [
            {
                "name": "TheEggMan",
                "score": 0,
                "time": {
                    "seconds": 4104.6127929688,
                    "minutes": 68.410213216146,
                    "hours": 1.1401702202691
                }
            }
        ]
    },
    "cached": false
}

Multiple Servers

GET https://use.gameapis.net/ark/query/info/{IP}:{PORT},{IP2}:{PORT2}
{
    "{IP}:{PORT}": {
        "status": true,
        "hostname": "{IP}",
        "port": {PORT},
        "name": "Ark Server",
        "map": "Ragnarok",
        "secure": true,
        "password_protected": false,
        "join": "steam://connect/{IP}:{PORT}/",
        "version": "1.0.0.0",
        "protocol": 17,
        "players": {
            "online": 0,
            "max": 100,
            "list": null
        },
        "cached": false
    },
    "{IP2}:{PORT2}": {
        "status": true,
        "hostname": "{IP2}",
        "port": {PORT2},
        "name": "Ark Server",
        "map": "Ragnarok",
        "secure": true,
        "password_protected": false,
        "join": "steam://connect/{IP2}:{PORT2}/",
        "version": "1.0.0.0",
        "protocol": 17,
        "players": {
            "online": 1,
            "max": 100,
            "list": [
                {
                    "name": "TheEggMan",
                    "score": 0,
                    "time": {
                        "seconds": 4104.6127929688,
                        "minutes": 68.410213216146,
                        "hours": 1.1401702202691
                    }
                }
            ]
        },
        "cached": false
    }
}