Skip to main content
GET
/
v3
/
games
/
fivem
/
lookup
Get Fivem Server
curl --request GET \
  --url https://api.ricardoneud.com/v3/games/fivem/lookup \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Address: <x-address>'
{
  "ip": "123.45.67.89",
  "port": 30120,
  "status": "online",
  "name": "My FiveM Roleplay Server",
  "map": "Los Santos",
  "gamemode": "Roleplay",
  "version": "4568",
  "players": {
    "online": 2,
    "list": [
      {
        "id": 1,
        "name": "PlayerOne",
        "ping": 45
      },
      {
        "id": 2,
        "name": "PlayerTwo",
        "ping": 50
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Address
string
required

The address (domain or IP) of the Fivem server

X-Port
string

The port of the Fivem server (default is 30120)

Response

200 - application/json
ip
string
required
port
integer
required
status
string
required
name
string
required
map
string
required
gamemode
string
required
version
string
required
players
object
required
I