Servers API

List Servers

GET /api/servers

Returns a list of public Minecraft servers.

Query Parameters

Parameter	Type	Description
`category`	string	Filter by server category
`platform`	string	Filter by platform
`sort`	string	Sort by: "votes", "players", "newest"
`search`	string	Search by server name

Response Shape

interface Server {
  id: string;
  name: string;
  ip: string;
  port: number;
  description: string;
  category: string;
  icon: string | null;
  banner: string | null;
  website: string | null;
  discord: string | null;
  version: string | null;
  platforms: string[];
  votes: number;
  players: number;
  maxPlayers: number;
  featured: boolean;
  createdAt: string;
  updatedAt: string;
}

Create Server

POST /api/servers

Create a new server listing. Requires authentication.

Request Body

Field	Type	Required	Description
`name`	string	Yes	Server name (max 64 chars)
`ip`	string	Yes	Server IP address or hostname
`port`	number	No	Server port (default: 25565)
`description`	string	Yes	Server description (max 500 chars)
`category`	string	Yes	Server category
`version`	string	No	Minecraft version
`platforms`	string[]	No	Server platforms
`website`	string	No	Server website URL
`discord`	string	No	Discord invite URL

Example Response

{
  "id": "clx1abc123",
  "name": "My Server",
  "ip": "play.myserver.com",
  "port": 25565,
  "description": "A great survival server",
  "category": "survival",
  "votes": 0,
  "players": 0,
  "maxPlayers": 100,
  "createdAt": "2025-01-01T00:00:00.000Z"
}