API Dokumantasyonu

Hizli baslangic

Uc adimda ilk yanitinizi alin. Butun uclar yalnizca okuma yapar; kimse sizin adiniza veri degistiremez.

Anahtar alin
Yukaridaki kutudan bir anahtar olusturun. Anahtarlar nrz_ ile baslar ve yalnizca bir kez gosterilir.
Ilk istegi atin
Anahtari Authorization: Bearer basligiyla gonderin. Genel istatistikler en kolay baslangictir.
Sayfalayin ve izleyin
Listeler limit ve offset ile sayfalanir. Kalan hakki X-RateLimit-Remaining basligindan okuyun.

Terminal

curl "https://metrics.nerzen.com/api/v1/global" \
  -H "Authorization: Bearer SIZIN_ANAHTARINIZ"

Kimlik dogrulama

Her /api/v1 istegi bir anahtar ister (anahtar olusturma ucu haric). Iki yol var; baslik tercih edilir cunku adres satirlari loglara ve tarayici gecmisine dusebilir.

OnerilenBaslik

Authorization: Bearer nrz_...

AlternatifSorgu parametresi

/api/v1/global?key=nrz_...

Anahtari tarayicida calisan koda (site JavaScript'i, istemci tarafli eklentiler) koymayin; sayfayi acan herkes gorebilir. Sunucu tarafinda bir ortam degiskeninde tutun.

Hiz limiti

Her anahtar dakikada 60 istek yapabilir. Pencere, penceredeki ilk istekle baslar ve 60 saniye surer. Limit asildiginda 429 doner; Retry-After kac saniye beklemeniz gerektigini soyler.

Baslik	Ne zaman	Anlami
`X-RateLimit-Limit`	Her dogrulanmis yanit	Dakikalik hak (60)
`X-RateLimit-Remaining`	Basarili yanitlar	Bu penceredeki kalan istek
`Retry-After`	Yalnizca 429	Yeni pencereye kalan saniye

Hatalar

Hatalar her zaman JSON'dir ve makinece okunabilir bir error kodu tasir. Mesaj metnine degil koda gore dallanin.

401 Yetkisizmissing_api_key

Anahtar gonderilmedi.

{"error":"missing_api_key","hint":"Pass ?key=... or Authorization: Bearer ... - see /api-docs"}

401 Yetkisizinvalid_api_key

Anahtar kayitli degil.

{"error":"invalid_api_key"}

404 Bulunamadinot_found

ID ile sunucu bulunamadi (/server/:id, /mc/:id).

{"error":"not_found"}

429 Cok fazla istekrate_limited

Dakikalik limit asildi. Retry-After basligi da gonderilir.

{"error":"rate_limited","retryAfterSeconds":23}

GET /api/v1/global #

Genel istatistikler

FiveM ve Minecraft icin ag geneli canli toplamlar. FiveM degerleri sunucu tarafinda kisa sure onbellekte tutulur; art arda istekler ayni degeri dondurebilir.

Yanit alanlari

Alan	Aciklama
`fivem.serverCount`sayi	Cevrimici FiveM sunucusu
`fivem.playersOnline`sayi	Toplam cevrimici oyuncu
`fivem.regionCount`sayi	Sunucu bulunan bolge sayisi (bilinmeyen bolge haric)
`fivem.dataPointsPerDay`sayi	Son 24 saatteki olcum sayisi
`fivem.gta5Players`sayi	GTA5 (gta5 + gta5enhanced) oyunculari
`fivem.rdr3Players`sayi	RedM (rdr3) oyunculari
`minecraft.serverCount`sayi	Izlenen Minecraft sunucusu
`minecraft.playersOnline`sayi	Izlenen sunucularda son bilinen oyuncu toplami

fivem: son 15 dakikada gorulen sunucular uzerinden hesaplanir.
dataPointsPerDay: son 24 saatte kaydedilen anlik goruntu sayisi.

Durum kodlari

200 OK 401 Yetkisiz 429 Cok fazla istek

curl "https://metrics.nerzen.com/api/v1/global" \
  -H "Authorization: Bearer SIZIN_ANAHTARINIZ"

const res = await fetch('https://metrics.nerzen.com/api/v1/global', {
  headers: { Authorization: 'Bearer ' + process.env.NERZEN_KEY },
});
if (!res.ok) throw new Error('HTTP ' + res.status);
const data = await res.json();
console.log(data.fivem.playersOnline, 'oyuncu cevrimici');

import os, requests

r = requests.get(
    "https://metrics.nerzen.com/api/v1/global",
    headers={"Authorization": f"Bearer {os.environ['NERZEN_KEY']}"},
    timeout=10,
)
r.raise_for_status()
data = r.json()
print(data["fivem"]["playersOnline"], "oyuncu cevrimici")

Ornek yanit · 200

{
  "fivem": {
    "serverCount": 34970,
    "playersOnline": 130534,
    "regionCount": 119,
    "dataPointsPerDay": 49442849,
    "gta5Players": 126063,
    "rdr3Players": 4471
  },
  "minecraft": {
    "serverCount": 17,
    "playersOnline": 269
  }
}

Canli veriden uretildi · 15:35

Denekendi anahtarinizla, bu tarayicidan

Once bir anahtar girin.

Yanit

GET /api/v1/servers #

FiveM sunucu arama

Cevrimici FiveM sunuculari, oyuncu sayisina gore azalan sirada. Sayfalama limit ve offset ile yapilir.

Parametreler

Ad	Varsayilan	Aciklama
`q`metin	-	Sunucu adi veya proje adinda gecen ifade (buyuk/kucuk harf duyarsiz).
`region`metin	-	Iki harfli bolge kodu, ornek TR, DE, BR.
`game`metin	-	gta5, rdr3 veya gta5enhanced.
`limit`sayi	24	Sayfa boyutu, en fazla 50. Daha buyuk deger 50'ye indirilir.
`offset`sayi	0	Atlanacak kayit sayisi.

Yanit alanlari

Alan	Aciklama
`id`metin	Sunucu ID'si
`hostname`metin	Sunucu adi; FiveM renk kodlari (^1..^9) ham olarak doner
`gametype`metin	Oyun turu (sunucunun bildirdigi)
`mapname`metin	Harita adi
`region`metin	Iki harfli bolge kodu, bilinmiyorsa ??
`tags`metin[]	Sunucu etiketleri
`clients`sayi	Cevrimici oyuncu
`max_clients`sayi	Oyuncu kapasitesi
`connect_endpoint`metin	Baglanti adresi; Nerzen korumali sunucularda maskelenir
`protected`mantiksal	Nerzen Guard korumasinda mi
`first_seen`ISO tarih	Ilk goruldugu an (UTC)
`last_seen`ISO tarih	Son goruldugu an (UTC)

Yalnizca son 20 dakikada listede gorulen sunucular doner.
total, filtreye uyan toplam sunucu sayisidir; sayfalama icin kullanin.

Durum kodlari

200 OK 401 Yetkisiz 429 Cok fazla istek

curl "https://metrics.nerzen.com/api/v1/servers?region=TR&limit=5" \
  -H "Authorization: Bearer SIZIN_ANAHTARINIZ"

const res = await fetch('https://metrics.nerzen.com/api/v1/servers?region=TR&limit=5', {
  headers: { Authorization: 'Bearer ' + process.env.NERZEN_KEY },
});
if (!res.ok) throw new Error('HTTP ' + res.status);
const data = await res.json();
console.log(data.total, 'sunucu');
for (const s of data.servers) console.log(s.id, s.clients);

import os, requests

r = requests.get(
    "https://metrics.nerzen.com/api/v1/servers",
    params={"region": "TR", "limit": "5"},
    headers={"Authorization": f"Bearer {os.environ['NERZEN_KEY']}"},
    timeout=10,
)
r.raise_for_status()
data = r.json()
for s in data["servers"]:
    print(s["id"], s["clients"])

Ornek yanit · 200

{
  "total": 35044,
  "limit": 2,
  "offset": 0,
  "servers": [
    {
      "id": "67lzxd",
      "hostname": "SHARK COMMUNITY",
      "gametype": "NCCore",
      "mapname": "Shark Community",
      "region": "TH",
      "tags": [],
      "clients": 1905,
      "max_clients": 2048,
      "connect_endpoint": "https://private-placeholder.cfx.re/",
      "protected": false,
      "first_seen": "2026-07-20T15:43:55.194Z",
      "last_seen": "2026-09-25T12:34:23.947Z"
    },
    {
      "id": "3yyb95b",
      "hostname": "OKI TOWN @REBIRTHZVPS",
      "gametype": "",
      "mapname": "San Andreas",
      "region": "TH",
      "tags": [
        "esx",
        "th",
        "rp",
        "community"
      ],
      "clients": 1581,
      "max_clients": 2048,
      "connect_endpoint": "https://private-placeholder.cfx.re/",
      "protected": false,
      "first_seen": "2026-08-05T09:52:01.427Z",
      "last_seen": "2026-09-25T12:34:23.947Z"
    }
  ]
}

Canli veriden uretildi · 15:35

Denekendi anahtarinizla, bu tarayicidan

q region game limit offset

Once bir anahtar girin.

Yanit

GET /api/v1/server/:id #

Tek FiveM sunucusu

Bir FiveM sunucusunun son bilinen durumu. ID, sunucu sayfasinin adresindeki koddur: metrics.nerzen.com/view/ID.

Parametreler

Ad	Varsayilan	Aciklama
`id`zorunluyol	-	FiveM sunucu ID'si (cfx.re kodu).

Yanit alanlari

Alan	Aciklama
`id`metin	Sunucu ID'si
`hostname`metin	Sunucu adi; FiveM renk kodlari (^1..^9) ham olarak doner
`gametype`metin	Oyun turu (sunucunun bildirdigi)
`mapname`metin	Harita adi
`region`metin	Iki harfli bolge kodu, bilinmiyorsa ??
`tags`metin[]	Sunucu etiketleri
`clients`sayi	Cevrimici oyuncu
`max_clients`sayi	Oyuncu kapasitesi
`connect_endpoint`metin	Baglanti adresi; Nerzen korumali sunucularda maskelenir
`protected`mantiksal	Nerzen Guard korumasinda mi
`first_seen`ISO tarih	Ilk goruldugu an (UTC)
`last_seen`ISO tarih	Son goruldugu an (UTC)

Cevrimdisi sunucular da doner; last_seen ile tazeligi kontrol edin.

Durum kodlari

200 OK 401 Yetkisiz 404 Bulunamadi 429 Cok fazla istek

curl "https://metrics.nerzen.com/api/v1/server/67lzxd" \
  -H "Authorization: Bearer SIZIN_ANAHTARINIZ"

const res = await fetch('https://metrics.nerzen.com/api/v1/server/67lzxd', {
  headers: { Authorization: 'Bearer ' + process.env.NERZEN_KEY },
});
if (!res.ok) throw new Error('HTTP ' + res.status);
const data = await res.json();
console.log(data.hostname, data.clients + '/' + data.max_clients);

import os, requests

r = requests.get(
    "https://metrics.nerzen.com/api/v1/server/67lzxd",
    headers={"Authorization": f"Bearer {os.environ['NERZEN_KEY']}"},
    timeout=10,
)
r.raise_for_status()
data = r.json()
print(data["hostname"], data["clients"], "/", data["max_clients"])

Ornek yanit · 200

{
  "id": "67lzxd",
  "hostname": "SHARK COMMUNITY",
  "gametype": "NCCore",
  "mapname": "Shark Community",
  "region": "TH",
  "tags": [],
  "clients": 1905,
  "max_clients": 2048,
  "connect_endpoint": "https://private-placeholder.cfx.re/",
  "protected": false,
  "first_seen": "2026-07-20T15:43:55.194Z",
  "last_seen": "2026-09-25T12:34:23.947Z"
}

Canli veriden uretildi · 15:35

Denekendi anahtarinizla, bu tarayicidan

id

Once bir anahtar girin.

Yanit

GET /api/v1/mc #

Minecraft sunucu listesi

Nerzen aginda izlenen Minecraft sunuculari, oyuncu sayisina gore azalan sirada.

Parametreler

Ad	Varsayilan	Aciklama
`q`metin	-	MOTD icinde gecen ifade.
`limit`sayi	24	Sayfa boyutu, en fazla 50.
`offset`sayi	0	Atlanacak kayit sayisi.

Yanit alanlari

Alan	Aciklama
`id`metin	Sunucu ID'si (10 karakter)
`motd`metin	Sunucu mesaji, renk kodlari temizlenmis
`version_name`metin	Sunucunun bildirdigi surum
`players`sayi	Cevrimici oyuncu
`max_players`sayi	Oyuncu kapasitesi
`first_seen`ISO tarih	Ilk goruldugu an (UTC)
`last_seen`ISO tarih	Son goruldugu an (UTC)

motd renk kodlarindan (§) arindirilmis ham metindir, satirlar \n ile ayrilir.

Durum kodlari

200 OK 401 Yetkisiz 429 Cok fazla istek

curl "https://metrics.nerzen.com/api/v1/mc?limit=5" \
  -H "Authorization: Bearer SIZIN_ANAHTARINIZ"

const res = await fetch('https://metrics.nerzen.com/api/v1/mc?limit=5', {
  headers: { Authorization: 'Bearer ' + process.env.NERZEN_KEY },
});
if (!res.ok) throw new Error('HTTP ' + res.status);
const data = await res.json();
console.log(data.total, 'sunucu');
for (const s of data.servers) console.log(s.id, s.players);

import os, requests

r = requests.get(
    "https://metrics.nerzen.com/api/v1/mc",
    params={"limit": "5"},
    headers={"Authorization": f"Bearer {os.environ['NERZEN_KEY']}"},
    timeout=10,
)
r.raise_for_status()
data = r.json()
for s in data["servers"]:
    print(s["id"], s["players"])

Ornek yanit · 200

{
  "total": 17,
  "limit": 1,
  "offset": 0,
  "servers": [
    {
      "id": "045c27f2a8",
      "motd": "                  ⚔ ᴛʀᴘᴠᴘ.ᴄʟᴜʙ ⚔ \n      1.21.2+ ● ᴅᴜᴇʟꜱ | ꜰꜰᴀ | ᴛᴇᴀᴍꜱ ● TR",
      "version_name": "trpvp.club!",
      "players": 170,
      "max_players": 1000,
      "first_seen": "2026-07-20T18:05:31.737Z",
      "last_seen": "2026-09-25T12:34:34.247Z"
    }
  ]
}

Canli veriden uretildi · 15:35

Denekendi anahtarinizla, bu tarayicidan

q limit offset

Once bir anahtar girin.

Yanit

GET /api/v1/mc/:id #

Tek Minecraft sunucusu

Bir Minecraft sunucusunun son bilinen durumu. ID, metrics.nerzen.com/minecraft/ID adresindeki 10 karakterlik koddur.

Parametreler

Ad	Varsayilan	Aciklama
`id`zorunluyol	-	Minecraft sunucu ID'si.

Yanit alanlari

Alan	Aciklama
`id`metin	Sunucu ID'si (10 karakter)
`motd`metin	Sunucu mesaji, renk kodlari temizlenmis
`version_name`metin	Sunucunun bildirdigi surum
`players`sayi	Cevrimici oyuncu
`max_players`sayi	Oyuncu kapasitesi
`first_seen`ISO tarih	Ilk goruldugu an (UTC)
`last_seen`ISO tarih	Son goruldugu an (UTC)

Durum kodlari

200 OK 401 Yetkisiz 404 Bulunamadi 429 Cok fazla istek

curl "https://metrics.nerzen.com/api/v1/mc/045c27f2a8" \
  -H "Authorization: Bearer SIZIN_ANAHTARINIZ"

const res = await fetch('https://metrics.nerzen.com/api/v1/mc/045c27f2a8', {
  headers: { Authorization: 'Bearer ' + process.env.NERZEN_KEY },
});
if (!res.ok) throw new Error('HTTP ' + res.status);
const data = await res.json();
console.log(data.motd, data.players + '/' + data.max_players);

import os, requests

r = requests.get(
    "https://metrics.nerzen.com/api/v1/mc/045c27f2a8",
    headers={"Authorization": f"Bearer {os.environ['NERZEN_KEY']}"},
    timeout=10,
)
r.raise_for_status()
data = r.json()
print(data["motd"], data["players"], "/", data["max_players"])

Ornek yanit · 200

{
  "id": "045c27f2a8",
  "motd": "                  ⚔ ᴛʀᴘᴠᴘ.ᴄʟᴜʙ ⚔ \n      1.21.2+ ● ᴅᴜᴇʟꜱ | ꜰꜰᴀ | ᴛᴇᴀᴍꜱ ● TR",
  "version_name": "trpvp.club!",
  "players": 170,
  "max_players": 1000,
  "first_seen": "2026-07-20T18:05:31.737Z",
  "last_seen": "2026-09-25T12:34:34.247Z"
}

Canli veriden uretildi · 15:35

Denekendi anahtarinizla, bu tarayicidan

id

Once bir anahtar girin.

Yanit

POST /api/v1/keys Anahtar gerekmez #

API anahtari olustur

Yeni bir anahtar uretir. Kayit veya e-posta gerekmez. Anahtar yalnizca bu yanitta bir kez gosterilir.

Parametreler

Ad	Varsayilan	Aciklama
`label`metin (govde)	-	Kendi takibiniz icin etiket, en fazla 60 karakter. JSON veya form govdesi.

Bu uc anahtar istemez ve hiz limitine dahil degildir.

Durum kodlari

200 OK

curl -X POST "https://metrics.nerzen.com/api/v1/keys" \
  -H "Content-Type: application/json" \
  -d '{"label":"discord-botum"}'

const res = await fetch('https://metrics.nerzen.com/api/v1/keys', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"label":"discord-botum"}),
});
const { api_key } = await res.json();
// Anahtari bir ortam degiskenine kaydedin, koda gommeyin.

import requests

r = requests.post("https://metrics.nerzen.com/api/v1/keys", json={"label":"discord-botum"}, timeout=10)
r.raise_for_status()
print(r.json()["api_key"])

Ornek yanit · 200

{
  "api_key": "nrz_0000000000000000000000000000000000000000",
  "rate_limit_per_minute": 60,
  "docs": "https://metrics.nerzen.com/api-docs"
}

Rozetler

Anahtar gerektirmeyen, gomulebilir SVG rozetleri. Discord sunucu aciklamaniza, GitHub README'nize veya sitenize ekleyin. Yanitlar 60 saniye onbellekte tutulur; bilinmeyen bir ID icin gri "bulunamadi" rozeti doner.

Adres	Aciklama
`/badge/fivem/:id.svg`	FiveM sunucusu: ad ve oyuncu / kapasite
`/badge/mc/:id.svg`	Minecraft sunucusu: MOTD'nin ilk satiri ve oyuncu / kapasite

Canli ornek · en kalabalik FiveM sunucusu

![Oyuncular](https://metrics.nerzen.com/badge/fivem/67lzxd.svg)

<img src="https://metrics.nerzen.com/badge/fivem/67lzxd.svg" alt="oyuncu sayisi">

Sunucu sayfalarinda (Paylas bolumu) kendi sunucunuzun rozet kodunu tek tikla kopyalayabilirsiniz.

Nerzen API

Hizli baslangic

Anahtar alin

Ilk istegi atin

Sayfalayin ve izleyin

Kimlik dogrulama

Hiz limiti

Hatalar

Genel istatistikler

Yanit alanlari

Durum kodlari

FiveM sunucu arama

Parametreler

Yanit alanlari

Durum kodlari

Tek FiveM sunucusu

Parametreler

Yanit alanlari

Durum kodlari

Minecraft sunucu listesi

Parametreler

Yanit alanlari

Durum kodlari

Tek Minecraft sunucusu

Parametreler

Yanit alanlari

Durum kodlari

API anahtari olustur

Parametreler

Durum kodlari

Rozetler