سرورها و جست‌وجو | داکیومنت گیم روت

این مسیرها همان داده‌های فهرست سرورها و صفحه هر سرور را برمی‌گردانند. فقط سرورهای تأییدشده دیده می‌شوند و همه با کلید یا بدون کلید کار می‌کنند.

مسیر	کاربرد
`GET /games`	فهرست بازی‌ها و شناسه هرکدام
`GET /servers`	فهرست، فیلتر و جست‌وجو
`GET /servers/{server}`	جزئیات کامل یک سرور

پارامتر {server} در همه مسیرها نامک (slug) یا شناسه (id) سرور است.

فهرست بازی‌ها#

Shell

curl https://gameroute.ir/api/v1/games

JSON

{
  "items": [
    { "id": "mta", "name": "MTA:SA", "nameFa": "ام‌تی‌ای", "defaultPort": 22003 },
    { "id": "vmp", "name": "VMP", "nameFa": "وی‌ام‌پی", "defaultPort": 30120 },
    { "id": "minecraft", "name": "Minecraft", "nameFa": "ماینکرفت", "defaultPort": 25565 }
  ]
}

فهرست و جست‌وجو#

Shell

curl "https://gameroute.ir/api/v1/servers?game=mta&tag=roleplay&sort=players&pageSize=10"

پارامتر	توضیح
`game`	`mta`، `vmp` یا `minecraft`
`q`	جست‌وجو در نام سرور (بدون حساسیت به حروف بزرگ و کوچک)، آدرس و برچسب‌ها؛ تا ۶۰ کاراکتر
`tag`	فقط سرورهایی که دقیقاً این برچسب را دارند
`sort`	`rank`، `players`، `rating` یا `new` (توضیح ترتیب‌ها)
`page` و `pageSize`	صفحه‌بندی؛ حداکثر ۶۰ سرور در هر صفحه

هر سرور در فهرست این فیلدها را دارد:

فیلد	توضیح
`id`، `slug`	شناسه و نامک
`url`	نشانی صفحه سرور در گیم روت
`game`	شناسه بازی
`name`، `shortDescription`	نام و توضیح کوتاه
`address`	آدرس اتصال همان‌طور که بازیکن وارد می‌کند (برای ماینکرفت با پورت پیش‌فرض، بدون پورت)
`host`، `port`	آدرس و پورت خام
`tags`	برچسب‌ها
`verified`	مالکیت سرور تأیید شده است
`sponsored`	سرور در حال حاضر جایگاه ویژه (اسپانسر) دارد
`rank`	جایگاه در رتبه‌بندی؛ فقط با `sort=rank`، وگرنه `null`
`boost`	`count` تعداد بوست‌های فعال و `level` سطح بوست
`rating`	`average` میانگین امتیاز (یک رقم اعشار) و `count` تعداد امتیازها
`record`	رکورد بازیکن همزمان و زمان آن
`branding`	رنگ، لوگو و بنر (نشانی کامل تصویر)
`badges`	نشان‌های سرور
`live`	آخرین وضعیت زنده یا `null` اگر هنوز بررسی نشده

جزئیات سرور#

Shell

curl https://gameroute.ir/api/v1/servers/iran-craft

علاوه بر فیلدهای فهرست:

فیلد	توضیح
`description`	توضیحات کامل به Markdown؛ HTML از آن حذف شده است
`socials`	پیوند شبکه‌ها با کلیدهای `website`، `discord`، `telegram`، `instagram`، `youtube`، `aparat` و `rubika` (فقط موارد پرشده)
`createdAt`	زمان ثبت در گیم روت
`uptime30d`	میانگین درصد آنلاین بودن در ۳۰ روز اخیر، یا `null`
`owner`	نام کاربری و نام نمایشی مالک، یا `null` اگر مالکیت تأیید نشده
`gallery`	تصاویر گالری با زیرنویس
`videos`	ویدیوها (`youtube`، `aparat` یا `upload`) با نشانی پخش

نمونه: جدول ۱۰ سرور برتر#

JavaScript

const res = await fetch('https://gameroute.ir/api/v1/servers?game=minecraft&pageSize=10');
const { items } = await res.json();
for (const s of items) {
  const players = s.live?.online ? `${s.live.players}/${s.live.maxPlayers}` : 'offline';
  console.log(`${s.rank}. ${s.name} — ${s.address} — ${players}`);
}