API Dokümantasyonu

Geliştiriciler için açık REST API. Sunucu verilerinizi kendi uygulamalarınızda kullanın.

Genel Bilgi

FiveXmetrics API, FiveM sunucularınızdan veri çekmek için basit ve hızlı bir REST API sunar. Kayıt veya API key gerektirmez.

Base URL /api
Format JSON
Önbellekleme 10 saniye
Auth Gerekli değil

GET /api/metrics

Sunucunun tüm metrik verilerini döndürür. Ana endpoint.

Parametreler

ip required 192.168.1.1:30120

Örnek İstek

// JavaScript / Fetch
const res = await fetch('/api/metrics?ip=192.168.1.1:30120');
const json = await res.json();
console.log(json.data);

Örnek Yanıt

{
  "success": true,
  "cached": false,
  "data": {
    "online": true,
    "ping": 42,
    "timestamp": 1704067200000,
    "server": {
      "hostname": "My FiveM Server",
      "description": "Türkçe RP Sunucusu",
      "gametype": "Roleplay",
      "mapname": "San Andreas",
      "locale": "tr-TR",
      "onesync": true,
      "tags": ["roleplay", "turkce"]
    },
    "players": {
      "online": 42,
      "max": 128,
      "avgPing": 65,
      "list": [...]
    },
    "resources": {
      "count": 156,
      "list": [...]
    }
  }
}

GET /api/status

Sadece sunucu durumunu (online/offline) ve ping bilgisini döndürür. Hızlı kontroller için.

Örnek Yanıt

{
  "success": true,
  "data": {
    "online": true,
    "ping": 42
  }
}

GET /api/players

Sadece oyuncu listesini döndürür. Sunucu üzerindeki tüm aktif oyuncular ve ping bilgileri.

Örnek Yanıt

{
  "success": true,
  "data": [
    {
      "id": 1,
      "name": "Player1",
      "ping": 45,
      "identifiers": [...]
    }
  ]
}

Hata Kodları

200 OK Başarılı yanıt
400 Bad Request Geçersiz IP veya eksik parametre
500 Server Error Sunucuya bağlanılamadı