Players API

The Players API provides endpoints for listing and managing players on your servers.

Base URL

https://api.caforahost.com/v1

Endpoints

List Online Players

GET /v1/servers/{server_id}/players

Returns a list of currently online players.

Kick Player

POST /v1/servers/{server_id}/players/{username}/kick

Kicks a player from the server with an optional reason.

Ban Player

POST /v1/servers/{server_id}/players/{username}/ban

Bans a player from the server.

Player Information

GET /v1/servers/{server_id}/players/{username}

Returns information about a specific player.

Example: List Players

import requests

headers = {"Authorization": f"Bearer {API_KEY}"}

response = requests.get(
    f"https://api.caforahost.com/v1/servers/{SERVER_ID}/players",
    headers=headers
)

players = response.json()
for player in players:
    print(f"{player['username']} - {player['ip']}")