Skip to content
GAMPEONCreate
GAMPEON on Discord
New project

Server browser

GET
/v1/servers
curl --request GET \
  --url https://api.gampeon.com/v1/servers

Servers that are online, sorted by player count (up to 500).

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
q
string

Search in the server name

tag
string

Filter by tag

Responses

Section titled “Responses”

200

Section titled “200”

Servers

Media typeapplication/json
object
servers
required
Array<object>
object
id
required

Server ID

string format: uuid
name
required
string
description
required
string
website
required
One of:
string
owner
required
object
handle
required

Unique handle

string
/^[a-z0-9_]{3,24}$/
displayName
required
string
avatar
One of:

Image path relative to the API (/v1/media/…). null without an image.

string
online
required

Sent a heartbeat in the last 90 seconds

boolean
address
required
One of:

Host name or IP address players connect to

string
port
required
One of:
integer
players
required
integer
maxPlayers
required
integer
tags
required
Array<string>
language
required
One of:

Language code such as en or de-DE

string
lastSeen
required

Last heartbeat (Unix time in milliseconds)

integer format: int64
peakPlayers
required

Highest player count reported over two consecutive heartbeats

integer
project
required
One of:
object
slug
required
string
title
required
string
total
required
integer

Example generated

{
  "servers": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "name": "example",
      "description": "example",
      "website": "example",
      "owner": {
        "handle": "example",
        "displayName": "example",
        "avatar": "example"
      },
      "online": true,
      "address": "example",
      "port": 1,
      "players": 1,
      "maxPlayers": 1,
      "tags": [
        "example"
      ],
      "language": "example",
      "lastSeen": 1,
      "peakPlayers": 1,
      "project": {
        "slug": "example",
        "title": "example"
      }
    }
  ],
  "total": 1
}

Report a problem with this pageOther ways to give feedback