Players API

Endpoint: GET /api/players

Returns a comma-separated list of currently online player names. Available on all supported platforms.

Response

Content-Type: text/plain

Alice,Bob,Charlie

If no players are online, the response is an empty string.

Rate Limiting

This endpoint uses the rate-limit.players configuration:

rate-limit:
  players:
    requests: 200
    per: 20s

Example Usage

JavaScript (Browser)

fetch('/api/players')
    .then(response => response.text())
    .then(data => {
        const players = data.split(',').filter(name => name.length > 0);
        console.log('Online players:', players);
    });

cURL

curl http://your-server:8080/api/players

Python

import requests
response = requests.get('http://your-server:8080/api/players')
players = response.text.split(',')
print(f'Online players: {players}')

Note

The players API returns player names as reported by the server platform. On proxy platforms (Velocity, BungeeCord), this returns players connected to the proxy, not a specific backend server.