REST APISin clave de APICORSJSON · PNG · HTML

Plataforma para desarrolladores MCAPI.TR

Documentación de API

La guía completa para desarrolladores de MCAPI.TR: servidores Minecraft Java, Legacy y Bedrock, iconos, banners, widgets, tendencias y estadísticas de la plataforma.

URL basehttps://mcapi.tr/api/v1

01 — Inicio rápido

Obtén tu primera respuesta en segundos

Sin configuración ni claves. Elige un cliente, copia el ejemplo y ejecútalo.

curl
curl "https://mcapi.tr/api/v1/status/mc.hypixel.net"

02 — Área de pruebas API

Envía una solicitud en vivo desde tu navegador

La solicitud va directamente a la API de MCAPI.TR y la respuesta formateada aparece abajo.

03 — Referencia de endpoints

Todos los endpoints públicos

Abre una tarjeta para ver parámetros, caché y ejemplos ejecutables.

GET/api/v1/status

Estado de la API

Verifica disponibilidad, versión y hora del servidor. Endpoint ligero para monitores de disponibilidad.

application/json
Autenticación
No requiere clave de API
Caché
Ninguna
Content-Type
application/json

Solicitud de ejemplo

bash
curl "https://mcapi.tr/api/v1/status"

Respuesta de ejemplo

json
{
  "status": "OK",
  "timestamp": "2026-09-08T20:12:00.000Z",
  "service": "mcapi.tr-engine",
  "version": "0.1.0"
}
GET/api/v1/status/:address

Estado del servidor Minecraft

Devuelve el estado de servidores Java, Legacy Java o Bedrock con jugadores, versión, MOTD, icono y latencia.

application/json
Autenticación
No requiere clave de API
Caché
60 segundos por defecto
Content-Type
application/json

Parámetros

ParámetroUbicaciónTipoPredeterminadoDescripción
address*pathstringHostname o IP; se puede añadir un puerto: play.example.net:25565
legacyquerybooleanfalseFuerza el protocolo ping de Java anterior a 1.7.2.
bedrockquerybooleanfalseUsa la consulta de Bedrock Edition; el puerto predeterminado pasa a 19132.

Solicitud de ejemplo

bash
curl "https://mcapi.tr/api/v1/status/mc.hypixel.net"
curl "https://mcapi.tr/api/v1/status/bedrock.example.net:19132?bedrock=true"

Respuesta de ejemplo

json
{
  "query": {
    "host": "mc.hypixel.net",
    "port": 25565,
    "legacy": false,
    "bedrock": false
  },
  "server_id": "f17d4f75-...",
  "ip_address": "209.222.115.11",
  "icmp": true,
  "online": true,
  "error": null,
  "version": { "name": "Requires MC 1.8 / 1.21", "protocol": 47 },
  "players": { "online": 52184, "max": 200000, "sample": [] },
  "motd": {
    "raw": "§aHypixel Network",
    "clean": "Hypixel Network",
    "html": "<span style=\"color:#55FF55\">Hypixel Network</span>",
    "raw_lines": ["§aHypixel Network"],
    "clean_lines": ["Hypixel Network"]
  },
  "favicon": "data:image/png;base64,...",
  "roundTripLatency": 18
}
GET/api/v1/stats

Estadísticas globales

Proporciona totales de solicitudes, servidores comprobados, tasa online, jugadores activos y comprobaciones recientes.

application/json
Autenticación
No requiere clave de API
Caché
60 sec
Content-Type
application/json

Solicitud de ejemplo

bash
curl "https://mcapi.tr/api/v1/stats"

Respuesta de ejemplo

json
{
  "totalRequests": 1284502,
  "apiRequests": 612340,
  "serverQueries": 672162,
  "totalChecks": 672162,
  "onlineServers": 428,
  "offlineServers": 91,
  "activePlayers": 184205,
  "recentChecks": [],
  "onlineRate": 82.5
}
GET/api/v1/icon/dynamic

Icono del servidor

Devuelve el favicon del servidor o la imagen predeterminada de MCAPI.TR si no está disponible.

image/png | image/webp
Autenticación
No requiere clave de API
Caché
Navegador 1 día, CDN 7 días
Content-Type
image/png | image/webp

Parámetros

ParámetroUbicaciónTipoPredeterminadoDescripción
address*querystringDirección del servidor. server se acepta como alias compatible.
sizequeryinteger80Tamaño WebP entre 16 y 256 píxeles.
formatquerypng | webppngProduce una imagen cuadrada optimizada al usar webp.

Solicitud de ejemplo

bash
curl "https://mcapi.tr/api/v1/icon/dynamic?address=mc.hypixel.net&size=128&format=webp" --output server.webp
GET/api/v1/icon/sharp

Icono redondeado

Produce un icono PNG redimensionado con esquinas redondeadas.

image/png
Autenticación
No requiere clave de API
Caché
Navegador 1 día, CDN 7 días
Content-Type
image/png

Parámetros

ParámetroUbicaciónTipoPredeterminadoDescripción
address*querystringHostname o dirección IP del servidor.
sizequeryinteger128Tamaño de salida entre 32 y 512 píxeles.

Solicitud de ejemplo

bash
curl "https://mcapi.tr/api/v1/icon/sharp?address=mc.hypixel.net&size=256" --output icon.png
GET/api/v1/banner/:address

Banner de estado

Crea un banner PNG compartible con nombre, jugadores, MOTD, ping y favicon.

image/png
Autenticación
No requiere clave de API
Caché
Según la política del servidor/CDN
Content-Type
image/png

Parámetros

ParámetroUbicaciónTipoPredeterminadoDescripción
address*pathstringServidor usado para generar el banner.
sizequerysmall | normal | largenormalDimensiones: 400×130, 600×180 u 800×240.
stylequerymodern | classicmodernApariencia del banner.
textColorqueryhex color#FFFFFFColor principal del texto.
accentColorqueryhex color#10B981Color de acento del número de jugadores.
showFavicon / showMotd / showPingquerybooleantrueActiva o desactiva icono, MOTD y latencia por separado.
borderRadiusquerynumber0.5Multiplicador del radio de esquina.

Solicitud de ejemplo

bash
curl "https://mcapi.tr/api/v1/banner/mc.hypixel.net?size=large&accentColor=%2310B981" --output banner.png
GET/api/v1/banner/motd

Banner de texto MOTD

Convierte texto MOTD con formato Minecraft en un PNG de 800×180 sin consultar un servidor.

image/png
Autenticación
No requiere clave de API
Caché
Sin caché de aplicación
Content-Type
image/png

Parámetros

ParámetroUbicaciónTipoPredeterminadoDescripción
motd*querystringTexto MOTD de hasta 300 caracteres.
textColorqueryhex color#FFFFFFColor de texto predeterminado.
accentColorqueryhex color#10B981Color de acento del fondo.

Solicitud de ejemplo

bash
curl "https://mcapi.tr/api/v1/banner/motd?motd=%C2%A7aWelcome" --output motd.png
GET/api/v1/widget/:size/:address

Widget HTML integrable

Devuelve HTML personalizable con estado en vivo para sitios web y paneles.

text/html
Autenticación
No requiere clave de API
Caché
60 sec + stale-while-revalidate
Content-Type
text/html

Parámetros

ParámetroUbicaciónTipoPredeterminadoDescripción
size*pathsmall | normal | largeDiseño y altura predeterminada del widget.
address*pathstringDirección del servidor; se puede usar demo para previsualizar.
themequerydark | lightdarkTema de color base.
showPlayers / showVersion / showMotdquerybooleantrueActiva o desactiva los campos principales por separado.
showLatency / showFaviconquerybooleantrueControla la visibilidad de ping y favicon.
showProtocol / showBorderquerybooleanfalseMuestra opcionalmente protocolo y borde.
bgColor / textColorqueryhex colorColores de fondo y texto del widget.
onlineColor / offlineColorqueryhex color#10b981 / #ef4444Colores de estado online y offline.
gradientBg / gradientFrom / gradientToqueryboolean / hexfalseControles del fondo degradado.
statusIndicatorquerydot | text | badge | nonedotEstilo del indicador de estado.
iconSizequerysmall | medium | largemediumTamaño del favicon.
fontqueryInter | Roboto | Poppins | Montserrat | OutfitFamilia de Google Fonts.
textAlignqueryleft | center | rightleftAlineación del texto.
customHeightqueryCSS pxAltura personalizada entre 50 y 600 píxeles.
borderRadius / borderWidthquerynumber0.75 / 1Medidas de esquinas y borde.
hoverEffect / glowEffect / boxShadowquerybooleanfalseActiva efectos visuales.
playerBarStylequerydefault | gradient | striped | animateddefaultApariencia de la barra de ocupación.

Solicitud de ejemplo

bash
curl "https://mcapi.tr/api/v1/widget/normal/mc.hypixel.net?theme=dark&showFavicon=true"

04 — Esquema

Campos de respuesta del servidor

CampoTipoDescripción
queryobjectHost, puerto y modo de consulta resueltos.
server_idUUIDIdentificador estable del servidor en MCAPI.TR.
onlinebooleanIndica si el ping de Minecraft se completó correctamente.
icmpbooleanResultado de accesibilidad ICMP de la IP de destino.
versionobject | nullNombre de versión y número de protocolo.
playersobject | nullJugadores online, capacidad y muestra opcional.
motdobject | nullFormatos MOTD original, limpio y HTML con listas de líneas.
favicondata URL | nullFavicon del servidor codificado en Base64.
roundTripLatencynumber | nullLatencia de consulta en milisegundos.
errorstring | nullResumen seguro del error de una consulta fallida.

HTTP

Códigos de estado

200Solicitud correcta.
400Dirección o parámetros no válidos.
404Servidor offline o no accesible.
429Límite de solicitudes por minuto superado.
500Error inesperado del servidor.
503Modo de mantenimiento activo.

Políticas

Límites y caché

  • status:120 solicitudes por minuto y por IP.
  • default:300 solicitudes por minuto por defecto para endpoints generales.
  • media:Hasta 5.000 solicitudes por minuto para iconos, banners y widgets.
  • cors:Los endpoints públicos permiten todos los orígenes del navegador.
  • privacy:El perfilado de solicitudes no conserva IP sin procesar ni agentes de usuario.

SDK de Node.js

mcapitr

Usa el cliente ligero de NPM para delegar la creación de URL y el procesamiento de respuestas.

CommonJSTypeScriptPromise API
bash
npm install mcapitr