Referencia de la API

Todos los endpoints de la API de oxb: servidor, estadísticas, baneos, jugadores, logs, administradores y acciones, con parámetros y ejemplos.

Base: https://api.oxbservices.com/v1. Todas las rutas llevan x-api-key y x-api-secret (ver API Keys) y responden JSON.

Lectura#

Método y ruta	Parámetros	Devuelve
`GET /server`	—	Estado (`ONLINE`, `OFFLINE`, `BANNED`), nombre, IP, versión, jugadores y vencimiento de la licencia.
`GET /server/stats`	`window`: `24h` (por defecto), `7d`, `30d`	Estadísticas del servidor en esa ventana.
`GET /server/players`	—	Los jugadores conectados ahora (`count` y `players`).
`GET /server/bans`	`limit` (máx. 100), `page`, `reason`, `playerName`	Baneos activos, con jugador, identificadores y motivo.
`GET /server/bans-history`	`limit` (máx. 100), `page`, `reason`, `playerName`	Historial de baneos, incluidos los ya quitados.
`GET /server/config`	—	La configuración actual del servidor.
`GET /server/admins`	—	Administradores y sus permisos.
`GET /server/logs`	`limit` (máx. 500), `page`, `type` (varios separados por coma)	Registros de la actividad del servidor.
`POST /server/lookup`	cuerpo: `identifier`	Los jugadores que tienen ese identificador (actual o previo).

Acciones#

Método y ruta	Cuerpo (JSON)	Qué hace
`POST /server/kick`	`playerId`, `reason?`, `by?`	Expulsa a un jugador conectado.
`POST /server/ban`	`playerId`, `reason`, `duration?` (segundos), `evidence?`, `by?`	Banea a un jugador conectado.
`POST /server/ban/offline`	`playerLicense` o `identifiers[]`, `reason`, `details?`, `evidenceUrl?`, `by?`	Banea a un jugador aunque no esté conectado.
`POST /server/unban`	`banId`	Quita un baneo.
`POST /server/unban/last`	`count?` (máx. 10), `minutes?`	Quita los últimos baneos.
`POST /server/unban/all`	—	Quita todos los baneos del servidor.
`POST /server/screenshot`	`playerId`	Pide una captura de pantalla del jugador.
`POST /server/exec`	`command`, `by?`	Ejecuta un comando en la consola del servidor.
`POST /server/admin/add`	`discordId`, `permissions[]`	Añade un administrador con esos permisos.
`POST /server/admin/remove`	`discordId`	Quita un administrador.

Ejemplos#

Banear a un jugador conectado

curl -X POST https://api.oxbservices.com/v1/server/ban \
  -H "x-api-key: $OXB_KEY" -H "x-api-secret: $OXB_SECRET" \
  -H "Content-Type: application/json" \
  -d '{ "playerId": 42, "reason": "Uso de ejecutor", "duration": 86400, "by": "Mi bot" }'

Leer los jugadores en línea (Node.js)

const res = await fetch("https://api.oxbservices.com/v1/server/players", {
  headers: {
    "x-api-key": process.env.OXB_KEY,
    "x-api-secret": process.env.OXB_SECRET,
  },
});
if (!res.ok) throw new Error((await res.json()).code);
const { count, players } = await res.json();
console.log(`${count} jugadores`, players.map((p) => p.name));

Banear sin que esté conectado

curl -X POST https://api.oxbservices.com/v1/server/ban/offline \
  -H "x-api-key: $OXB_KEY" -H "x-api-secret: $OXB_SECRET" \
  -H "Content-Type: application/json" \
  -d '{ "playerLicense": "license:abc123…", "reason": "Cuenta alternativa de un baneado" }'

Última actualización: 11 de noviembre de 2026