REST APIAPI anahtarı yokCORSJSON · PNG · HTML

MCAPI.TR Geliştirici Platformu

API Dokümantasyonu

Minecraft Java, Legacy ve Bedrock sunucularını sorgulamak; ikon, banner, widget, trend ve platform istatistiklerini kullanmak için eksiksiz MCAPI.TR geliştirici rehberi.

Temel URLhttps://mcapi.tr/api/v1

01 — Hızlı başlangıç

İlk yanıtını saniyeler içinde al

Kurulum veya anahtar yok. Bir araç seç, örneği kopyala ve çalıştır.

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

02 — API Deneme Alanı

Tarayıcıdan canlı istek gönder

İstek doğrudan MCAPI.TR API'sine gider; sonuç aşağıda biçimlendirilir.

03 — Uç Referansı

Tüm herkese açık uçlar

Bir kartı açarak parametreleri, önbellek davranışını ve çalıştırılabilir örnekleri görebilirsin.

GET/api/v1/status

API sağlık kontrolü

Servisin ayakta olduğunu, sürümünü ve sunucu saatini doğrular. İzleme sistemleri için hafif uçtur.

application/json
Kimlik doğrulama
API anahtarı gerektirmez
Önbellek
Yok
Content-Type
application/json

Örnek istek

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

Örnek yanıt

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

Minecraft sunucu durumu

Java, Legacy Java veya Bedrock sunucusunun çevrimiçi durumunu; oyuncu, sürüm, MOTD, ikon ve gecikme bilgileriyle döndürür.

application/json
Kimlik doğrulama
API anahtarı gerektirmez
Önbellek
Varsayılan 60 saniye
Content-Type
application/json

Parametreler

ParametreKonumTipVarsayılanAçıklama
address*pathstringAlan adı veya IP; isteğe bağlı port eklenebilir: play.example.net:25565
legacyquerybooleanfalse1.7.2 öncesi Java ping protokolünü zorlar.
bedrockquerybooleanfalseBedrock Edition sorgusu yapar; varsayılan port 19132 olur.

Örnek istek

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

Örnek yanıt

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

Genel platform istatistikleri

Toplam istek, kontrol edilen sunucu, çevrimiçi oranı, aktif oyuncu ve son kontrol özetlerini verir.

application/json
Kimlik doğrulama
API anahtarı gerektirmez
Önbellek
60 sec
Content-Type
application/json

Örnek istek

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

Örnek yanıt

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

Sunucu ikonu

Sunucu favicon'unu döndürür; ikon yoksa MCAPI.TR varsayılan görselini kullanır.

image/png | image/webp
Kimlik doğrulama
API anahtarı gerektirmez
Önbellek
Tarayıcı 1 gün, CDN 7 gün
Content-Type
image/png | image/webp

Parametreler

ParametreKonumTipVarsayılanAçıklama
address*querystringSunucu adresi. server da geriye dönük takma ad olarak kabul edilir.
sizequeryinteger80WebP dönüşüm boyutu; 16–256 piksel.
formatquerypng | webppngwebp seçildiğinde optimize edilmiş kare görsel üretir.

Örnek istek

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

Yuvarlatılmış sunucu ikonu

Sunucu ikonunu yumuşak köşeli, yeniden boyutlandırılmış PNG olarak üretir.

image/png
Kimlik doğrulama
API anahtarı gerektirmez
Önbellek
Tarayıcı 1 gün, CDN 7 gün
Content-Type
image/png

Parametreler

ParametreKonumTipVarsayılanAçıklama
address*querystringSunucu alan adı veya IP adresi.
sizequeryinteger12832–512 piksel arası çıktı boyutu.

Örnek istek

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

Sunucu durum banner'ı

Sunucu adı, oyuncu sayısı, MOTD, ping ve favicon ile paylaşılabilir PNG banner oluşturur.

image/png
Kimlik doğrulama
API anahtarı gerektirmez
Önbellek
Sunucu/CDN politikasına bağlı
Content-Type
image/png

Parametreler

ParametreKonumTipVarsayılanAçıklama
address*pathstringBanner'ı üretilecek sunucu.
sizequerysmall | normal | largenormalÇıktı ölçüsü: 400×130, 600×180 veya 800×240.
stylequerymodern | classicmodernBanner görünümü.
textColorqueryhex color#FFFFFFAna metin rengi.
accentColorqueryhex color#10B981Oyuncu sayısı vurgu rengi.
showFavicon / showMotd / showPingquerybooleantrueİkon, MOTD ve gecikme alanlarını ayrı ayrı açıp kapatır.
borderRadiusquerynumber0.5Köşe yuvarlaklığı çarpanı.

Örnek istek

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

MOTD metin banner'ı

Minecraft renk kodlu MOTD metnini, bir sunucu sorgulamadan 800×180 PNG görsele dönüştürür.

image/png
Kimlik doğrulama
API anahtarı gerektirmez
Önbellek
Uygulama önbelleği yok
Content-Type
image/png

Parametreler

ParametreKonumTipVarsayılanAçıklama
motd*querystringEn fazla 300 karakter MOTD metni.
textColorqueryhex color#FFFFFFVarsayılan metin rengi.
accentColorqueryhex color#10B981Arka plan vurgu rengi.

Örnek istek

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

Gömülebilir HTML widget

Web siteleri ve paneller için özelleştirilebilir, canlı sunucu durumu HTML'i döndürür.

text/html
Kimlik doğrulama
API anahtarı gerektirmez
Önbellek
60 sec + stale-while-revalidate
Content-Type
text/html

Parametreler

ParametreKonumTipVarsayılanAçıklama
size*pathsmall | normal | largeWidget yerleşimi ve varsayılan yüksekliği.
address*pathstringSunucu adresi; önizleme için demo kullanılabilir.
themequerydark | lightdarkTemel renk teması.
showPlayers / showVersion / showMotdquerybooleantrueAna bilgi alanlarını ayrı ayrı açıp kapatır.
showLatency / showFaviconquerybooleantruePing ve favicon görünürlüğü.
showProtocol / showBorderquerybooleanfalseProtokol ve kenarlığı isteğe bağlı gösterir.
bgColor / textColorqueryhex colorWidget arka planı ve metin rengi.
onlineColor / offlineColorqueryhex color#10b981 / #ef4444Çevrimiçi ve çevrimdışı durum renkleri.
gradientBg / gradientFrom / gradientToqueryboolean / hexfalseGradyan arka plan seçenekleri.
statusIndicatorquerydot | text | badge | nonedotDurum gösterge biçimi.
iconSizequerysmall | medium | largemediumFavicon boyutu.
fontqueryInter | Roboto | Poppins | Montserrat | OutfitGoogle Fonts yazı tipi.
textAlignqueryleft | center | rightleftMetin hizası.
customHeightqueryCSS px50–600 piksel arası özel yükseklik.
borderRadius / borderWidthquerynumber0.75 / 1Köşe ve kenarlık ölçüleri.
hoverEffect / glowEffect / boxShadowquerybooleanfalseGörsel efektleri etkinleştirir.
playerBarStylequerydefault | gradient | striped | animateddefaultOyuncu doluluk çubuğu görünümü.

Örnek istek

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

04 — Şema

Sunucu yanıt alanları

AlanTipAçıklama
queryobjectÇözümlenen host, port ve sorgu modu.
server_idUUIDMCAPI.TR içindeki kararlı sunucu kimliği.
onlinebooleanMinecraft ping işleminin başarılı olup olmadığı.
icmpbooleanHedef IP'nin ICMP ping yanıtı.
versionobject | nullSunucunun sürüm adı ve protokol numarası.
playersobject | nullÇevrimiçi, kapasite ve isteğe bağlı örnek oyuncular.
motdobject | nullHam, temizlenmiş ve HTML MOTD biçimleri ile satır dizileri.
favicondata URL | nullBase64 kodlu sunucu ikonu.
roundTripLatencynumber | nullMilisaniye cinsinden Minecraft sorgu gecikmesi.
errorstring | nullBaşarısız sorgunun güvenli hata özeti.

HTTP

Durum kodları

200İstek başarılı.
400Adres veya sorgu parametresi geçersiz.
404Sunucu çevrimdışı ya da ulaşılamıyor.
429Dakikalık istek limiti aşıldı.
500Beklenmeyen sunucu hatası.
503Bakım modu etkin.

Politikalar

Limitler ve önbellek

  • status:IP başına dakikada 120 istek.
  • default:Genel uçlarda varsayılan dakikada 300 istek.
  • media:İkon, banner ve widget uçlarında dakikada 5.000 isteğe kadar.
  • cors:Herkese açık API uçlarında tüm tarayıcı origin'lerine açıktır.
  • privacy:İstek profillemesinde ham IP ve kullanıcı aracısı saklanmaz.

Node.js SDK

mcapitr

URL oluşturma ve yanıt çözümleme işlerini ince istemciye bırakmak istersen NPM paketini kullanabilirsin.

CommonJSTypeScriptPromise API
bash
npm install mcapitr