توسعه‌دهندگان

مرجع API

این صفحه مستقیماً از سند OpenAPI ساخته می‌شود که خود API از روی کد تولید می‌کند، پس همیشه با رفتار واقعی سرویس یکی است. نشانی پایه همه مسیرها https://gameroute.ir/api/v1 است و سند خام در /api/v1/openapi.json در دسترس است.

سقف درخواست: ۱۲۰ درخواست در دقیقه برای هر کلید و ۳۰ درخواست در دقیقه برای هر IP بدون کلید. همه پاسخ‌ها JSON هستند و خطاها شکل {"error":{"code","message"}} دارند.

کلید API برای «امتحان کنید»

کلید فقط در همین زبانه مرورگر (sessionStorage) نگه داشته می‌شود و فقط به /api/v1 فرستاده می‌شود. بدون کلید هم درخواست‌های عمومی با سقف کمتر کار می‌کنند. ساخت کلید

سرورها

فهرست، جست‌وجو و جزئیات سرورهای تأییدشده

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

GET/api/v1/servers

دسترسی: readبدون کلید هم کار می‌کند

سرورهای تأییدشده با همان ترتیب سایت. مرتب‌سازی rank ابتدا سرورهای دارای بوست فعال و سپس تعداد بازیکنان آنلاین را در نظر می‌گیرد. q در نام، آدرس و برچسب‌ها جست‌وجو می‌کند.

پارامترها

gamestringquery
شناسه بازی: mta، vmp یا minecraftیکی از: mta، vmp، minecraft
qstringquery
جست‌وجو در نام، آدرس و برچسب‌ها
tagstringquery
فقط سرورهای دارای این برچسب
editionstringquery
یکی از: java، bedrock
sortstringquery
ترتیب: rank (رتبه سایت)، players، rating یا newیکی از: rank، players، record، name، votes، rating، new، old · پیش‌فرض: rank
dirstringquery
یکی از: asc، desc
pageintegerquery
شماره صفحه، از ۱پیش‌فرض: 1
pageSizeintegerquery
تعداد مورد در هر صفحهپیش‌فرض: 24 · حداکثر 60

پاسخ 200

itemsarray<object>
idstring
slugstring
urlstring
نشانی صفحه سرور در گیم روت
gamestring
یکی از: "mta"، "vmp"، "minecraft"
namestring
shortDescriptionstring | null
addressstring
آدرس اتصال، همان‌طور که بازیکن وارد می‌کند
hoststring
portinteger
tagsarray<string>
verifiedboolean
sponsoredboolean
rankinteger | null
جایگاه در رتبه‌بندی؛ فقط با sort=rank
boostobject
countinteger
levelinteger
ratingobject
averagenumber
countinteger
recordobject
playersinteger
atstring | null
زمان به قالب ISO 8601 (UTC)
brandingobject
colorstring | null
logoUrlstring | null
bannerUrlstring | null
badgesarray<object>
keystring
namestring
descriptionstring
iconstring
colorstring
awardedAtstring
زمان به قالب ISO 8601 (UTC)
detailstring | null
liveobject | null
onlineboolean
playersinteger
maxPlayersinteger
rttMsinteger | null
زمان رفت‌وبرگشت از گیم روت تا سرور بازی (میلی‌ثانیه)
versionstring | null
mapstring | null
gamemodestring | null
queriedAtstring
زمان به قالب ISO 8601 (UTC)
totalinteger
pageinteger
pageSizeinteger
hasMoreboolean

خطاهای ممکن

400ورودی نامعتبر
429سقف درخواست در دقیقه پر شده است

curl "https://gameroute.ir/api/v1/servers"

نمونه پاسخ 200

{
  "items": [
    {
      "id": "cm2x7v1q30000abcd",
      "slug": "iran-craft",
      "url": "https://gameroute.ir/servers/iran-craft",
      "game": "minecraft",
      "name": "Iran Craft",
      "shortDescription": "سرور سروایول و اسکای‌بلاک با اقتصاد فعال",
      "address": "play.irancraft.ir",
      "host": "play.irancraft.ir",
      "port": 25565,
      "tags": [
        "survival",
        "skyblock"
      ],
      "verified": true,
      "sponsored": false,
      "rank": 1,
      "boost": {
        "count": 3,
        "level": 1
      },
      "rating": {
        "average": 4.6,
        "count": 87
      },
      "record": {
        "players": 612,
        "at": "2026-09-12T18:00:00.000Z"
      },
      "branding": {
        "color": "#36FFA8",
        "logoUrl": "https://gameroute.ir/media/logo/ab12.webp",
        "bannerUrl": null
      },
      "badges": [
        {
          "key": "record-500",
          "name": "رکورددار",
          "description": "رکورد ۵۰۰ بازیکن همزمان",
          "icon": "trophy",
          "color": "#F5A524",
          "awardedAt": "2026-09-12T18:00:00.000Z",
          "detail": "رکورد ۶۱۲ بازیکن همزمان"
        }
      ],
      "live": {
        "online": true,
        "players": 128,
        "maxPlayers": 300,
        "rttMs": 34,
        "version": "1.21.1",
        "map": null,
        "gamemode": "Survival",
        "queriedAt": "2026-10-31T09:41:00.000Z"
      }
    }
  ],
  "total": 214,
  "page": 1,
  "pageSize": 24,
  "hasMore": true
}

امتحان کنیدبدون کلید (سقف کمتر)

gamequery

qquerytagqueryeditionquery

sortquery

dirquery

pagequerypageSizequery

جزئیات سرور#

GET/api/v1/servers/{server}

دسترسی: readبدون کلید هم کار می‌کند

همه اطلاعات عمومی صفحه سرور: توضیحات (Markdown)، شبکه‌های اجتماعی، گالری، ویدیوها، آپتایم ۳۰ روزه و وضعیت زنده.

پارامترها

serverstringpathrequired
نامک (slug) یا شناسه سرور

پاسخ 200

idstring
slugstring
urlstring
نشانی صفحه سرور در گیم روت
gamestring
یکی از: "mta"، "vmp"، "minecraft"
namestring
shortDescriptionstring | null
addressstring
آدرس اتصال، همان‌طور که بازیکن وارد می‌کند
hoststring
portinteger
tagsarray<string>
verifiedboolean
sponsoredboolean
rankinteger | null
جایگاه در رتبه‌بندی؛ فقط با sort=rank
boostobject
countinteger
levelinteger
ratingobject
averagenumber
countinteger
recordobject
playersinteger
atstring | null
زمان به قالب ISO 8601 (UTC)
brandingobject
colorstring | null
logoUrlstring | null
bannerUrlstring | null
badgesarray<object>
keystring
namestring
descriptionstring
iconstring
colorstring
awardedAtstring
زمان به قالب ISO 8601 (UTC)
detailstring | null
liveobject | null
onlineboolean
playersinteger
maxPlayersinteger
rttMsinteger | null
زمان رفت‌وبرگشت از گیم روت تا سرور بازی (میلی‌ثانیه)
versionstring | null
mapstring | null
gamemodestring | null
queriedAtstring
زمان به قالب ISO 8601 (UTC)
descriptionstring | null
توضیحات کامل به Markdown
socialsobject
createdAtstring
زمان به قالب ISO 8601 (UTC)
uptime30dnumber | null
درصد آپتایم ۳۰ روز اخیر (۰ تا ۱۰۰)
ownerobject | null
usernamestring
displayNamestring | null
galleryarray<object>
urlstring
captionstring | null
videosarray<object>
providerstring
یکی از: "youtube"، "aparat"، "upload"
urlstring
titlestring | null

خطاهای ممکن

404سرور یا مورد درخواستی یافت نشد
429سقف درخواست در دقیقه پر شده است

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

نمونه پاسخ 200

{
  "id": "cm2x7v1q30000abcd",
  "slug": "iran-craft",
  "url": "https://gameroute.ir/servers/iran-craft",
  "game": "minecraft",
  "name": "Iran Craft",
  "shortDescription": "سرور سروایول و اسکای‌بلاک با اقتصاد فعال",
  "address": "play.irancraft.ir",
  "host": "play.irancraft.ir",
  "port": 25565,
  "tags": [
    "survival",
    "skyblock"
  ],
  "verified": true,
  "sponsored": false,
  "rank": 1,
  "boost": {
    "count": 3,
    "level": 1
  },
  "rating": {
    "average": 4.6,
    "count": 87
  },
  "record": {
    "players": 612,
    "at": "2026-09-12T18:00:00.000Z"
  },
  "branding": {
    "color": "#36FFA8",
    "logoUrl": "https://gameroute.ir/media/logo/ab12.webp",
    "bannerUrl": null
  },
  "badges": [
    {
      "key": "record-500",
      "name": "رکورددار",
      "description": "رکورد ۵۰۰ بازیکن همزمان",
      "icon": "trophy",
      "color": "#F5A524",
      "awardedAt": "2026-09-12T18:00:00.000Z",
      "detail": "رکورد ۶۱۲ بازیکن همزمان"
    }
  ],
  "live": {
    "online": true,
    "players": 128,
    "maxPlayers": 300,
    "rttMs": 34,
    "version": "1.21.1",
    "map": null,
    "gamemode": "Survival",
    "queriedAt": "2026-10-31T09:41:00.000Z"
  },
  "description": "## درباره سرور\nسروایول بدون لگ با پشتیبانی ۲۴ ساعته.",
  "socials": {
    "discord": "https://discord.gg/irancraft",
    "telegram": "https://t.me/irancraft"
  },
  "createdAt": "2026-03-02T10:00:00.000Z",
  "uptime30d": 99.2,
  "owner": {
    "username": "ali",
    "displayName": "علی"
  },
  "gallery": [],
  "videos": []
}

امتحان کنیدبدون کلید (سقف کمتر)

server *path

وضعیت زنده و آمار

وضعیت لحظه‌ای، بازیکنان، نمودار تاریخچه، رکوردها و نشان‌ها

وضعیت زنده#

GET/api/v1/servers/{server}/status

دسترسی: readبدون کلید هم کار می‌کند

نتیجه آخرین کوئری گیم روت از سرور. سرورها حدوداً هر دقیقه بررسی می‌شوند؛ اگر آخرین کوئری قدیمی‌تر از ۳ دقیقه باشد stale برابر true است.

پارامترها

serverstringpathrequired
نامک (slug) یا شناسه سرور

پاسخ 200

onlineboolean
playersinteger
maxPlayersinteger
rttMsinteger | null
زمان رفت‌وبرگشت از گیم روت تا سرور بازی (میلی‌ثانیه)
versionstring | null
mapstring | null
gamemodestring | null
queriedAtstring
زمان به قالب ISO 8601 (UTC)
serverIdstring
slugstring
staleboolean
اگر آخرین کوئری قدیمی‌تر از ۳ دقیقه باشد true است

خطاهای ممکن

404سرور یا مورد درخواستی یافت نشد
429سقف درخواست در دقیقه پر شده است

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

نمونه پاسخ 200

{
  "serverId": "cm2x7v1q30000abcd",
  "slug": "iran-craft",
  "online": true,
  "players": 128,
  "maxPlayers": 300,
  "rttMs": 34,
  "version": "1.21.1",
  "map": null,
  "gamemode": "Survival",
  "queriedAt": "2026-10-31T09:41:00.000Z",
  "stale": false
}

امتحان کنیدبدون کلید (سقف کمتر)

server *path

بازیکنان آنلاین#

GET/api/v1/servers/{server}/players

دسترسی: readبدون کلید هم کار می‌کند

فهرست نام بازیکنانی که سرور در آخرین کوئری گزارش کرده است. ماینکرفت فقط نمونه‌ای از نام‌ها را می‌فرستد و در این حالت partial برابر true است. بعضی سرورها فهرست بازیکن را گزارش نمی‌کنند.

پارامترها

serverstringpathrequired
نامک (slug) یا شناسه سرور

پاسخ 200

onlineinteger
تعداد بازیکنان آنلاین در آخرین کوئری
itemsarray<object>
namestring
scorenumber | null
pingnumber | null
partialboolean
بعضی بازی‌ها (ماینکرفت) فقط نمونه‌ای از نام‌ها را می‌فرستند
queriedAtstring | null
زمان به قالب ISO 8601 (UTC)

خطاهای ممکن

404سرور یا مورد درخواستی یافت نشد
429سقف درخواست در دقیقه پر شده است

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

نمونه پاسخ 200

{
  "online": 3,
  "items": [
    {
      "name": "Sina",
      "score": 42,
      "ping": 51
    },
    {
      "name": "Neda",
      "score": 17,
      "ping": 38
    },
    {
      "name": "Kian",
      "score": 5,
      "ping": 77
    }
  ],
  "partial": false,
  "queriedAt": "2026-10-31T09:41:00.000Z"
}

امتحان کنیدبدون کلید (سقف کمتر)

server *path

تاریخچه بازیکنان#

GET/api/v1/servers/{server}/stats

دسترسی: readبدون کلید هم کار می‌کند

نقاط نمودار بازیکنان: برای 24h نتایج خام هر کوئری، برای 7d میانگین ساعتی و برای 30d میانگین روزانه. در هر نقطه players میانگین و max بیشینه همان بازه است. زمان‌ها UTC هستند.

پارامترها

serverstringpathrequired
نامک (slug) یا شناسه سرور
rangestringquery
بازه زمانی نموداریکی از: 24h، 7d، 30d · پیش‌فرض: 24h

پاسخ 200

rangestring
یکی از: "24h"، "7d"، "30d"
resolutionstring
یکی از: "raw"، "hour"، "day"
pointsarray<object>
tstring
زمان به قالب ISO 8601 (UTC)
playersinteger
میانگین بازیکنان در این بازه
maxinteger
بیشترین بازیکن در این بازه
summaryobject
avgPlayersnumber | null
peakPlayersinteger | null
uptimePctnumber | null

خطاهای ممکن

400ورودی نامعتبر
404سرور یا مورد درخواستی یافت نشد
429سقف درخواست در دقیقه پر شده است

curl "https://gameroute.ir/api/v1/servers/iran-craft/stats?range=7d"

نمونه پاسخ 200

{
  "range": "7d",
  "resolution": "hour",
  "points": [
    {
      "t": "2026-10-30T18:00:00.000Z",
      "players": 141,
      "max": 163
    },
    {
      "t": "2026-10-30T19:00:00.000Z",
      "players": 172,
      "max": 190
    }
  ],
  "summary": {
    "avgPlayers": 156.5,
    "peakPlayers": 190,
    "uptimePct": 99.6
  }
}

امتحان کنیدبدون کلید (سقف کمتر)

server *pathrangequery

رکوردها#

GET/api/v1/servers/{server}/records

دسترسی: readبدون کلید هم کار می‌کند

رکورد همیشگی بازیکنان همزمان و بیشترین تعداد بازیکن در ۲۴ ساعت، ۷ روز و ۳۰ روز گذشته.

پارامترها

serverstringpathrequired
نامک (slug) یا شناسه سرور

پاسخ 200

allTimeobject
playersinteger
atstring | null
زمان به قالب ISO 8601 (UTC)
peak24hobject | null
playersinteger
atstring
زمان به قالب ISO 8601 (UTC)
peak7dobject | null
playersinteger
atstring
زمان به قالب ISO 8601 (UTC)
peak30dobject | null
playersinteger
atstring
زمان به قالب ISO 8601 (UTC)

خطاهای ممکن

404سرور یا مورد درخواستی یافت نشد
429سقف درخواست در دقیقه پر شده است

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

نمونه پاسخ 200

{
  "allTime": {
    "players": 612,
    "at": "2026-09-12T18:00:00.000Z"
  },
  "peak24h": {
    "players": 190,
    "at": "2026-10-30T19:12:00.000Z"
  },
  "peak7d": {
    "players": 233,
    "at": "2026-10-27T20:00:00.000Z"
  },
  "peak30d": {
    "players": 301,
    "at": "2026-10-10T00:00:00.000Z"
  }
}

امتحان کنیدبدون کلید (سقف کمتر)

server *path

نشان‌ها#

GET/api/v1/servers/{server}/badges

دسترسی: readبدون کلید هم کار می‌کند

نشان‌هایی که سرور گرفته است، به ترتیب اولویت نمایش.

پارامترها

serverstringpathrequired
نامک (slug) یا شناسه سرور

پاسخ 200

itemsarray<object>
keystring
namestring
descriptionstring
iconstring
colorstring
awardedAtstring
زمان به قالب ISO 8601 (UTC)
detailstring | null

خطاهای ممکن

404سرور یا مورد درخواستی یافت نشد
429سقف درخواست در دقیقه پر شده است

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

نمونه پاسخ 200

{
  "items": [
    {
      "key": "record-500",
      "name": "رکورددار",
      "description": "رکورد ۵۰۰ بازیکن همزمان",
      "icon": "trophy",
      "color": "#F5A524",
      "awardedAt": "2026-09-12T18:00:00.000Z",
      "detail": "رکورد ۶۱۲ بازیکن همزمان"
    }
  ]
}

امتحان کنیدبدون کلید (سقف کمتر)

server *path

اخبار

خواندن و مدیریت اخبار سرور

اخبار سرور#

GET/api/v1/servers/{server}/news

دسترسی: readبدون کلید هم کار می‌کند

خبرهای سرور از جدید به قدیم: پست‌های داخلی تیم و موارد منابع متصل.

پارامترها

serverstringpathrequired
نامک (slug) یا شناسه سرور
pageintegerquery
شماره صفحه، از ۱پیش‌فرض: 1
pageSizeintegerquery
تعداد مورد در هر صفحهپیش‌فرض: 20 · حداکثر 50

پاسخ 200

itemsarray<object>
idstring
sourcestring
یکی از: "telegram"، "discord"، "instagram"، "internal"
titlestring | null
bodystring
imageUrlstring | null
linkstring | null
publishedAtstring
زمان به قالب ISO 8601 (UTC)
totalinteger
pageinteger
pageSizeinteger
hasMoreboolean

خطاهای ممکن

400ورودی نامعتبر
404سرور یا مورد درخواستی یافت نشد
429سقف درخواست در دقیقه پر شده است

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

نمونه پاسخ 200

{
  "items": [
    {
      "id": "cm3n2k8x40001",
      "source": "internal",
      "title": "فصل جدید شروع شد",
      "body": "نقشه جدید و جوایز هفتگی از امشب فعال است.",
      "imageUrl": null,
      "link": "https://irancraft.ir/season-5",
      "publishedAt": "2026-10-30T16:00:00.000Z"
    }
  ],
  "total": 12,
  "page": 1,
  "pageSize": 20,
  "hasMore": false
}

امتحان کنیدبدون کلید (سقف کمتر)

server *pathpagequerypageSizequery

انتشار خبر#

POST/api/v1/servers/{server}/news

دسترسی: news:writeکلید API لازم است

یک پست داخلی منتشر می‌کند. کلید باید برای همین سرور ساخته شده باشد و سازنده کلید همچنان دسترسی «مدیریت اخبار» را در تیم داشته باشد. imageUrl فقط تصویری است که قبلاً در پنل بارگذاری شده است.

پارامترها

serverstringpathrequired
نامک (slug) یا شناسه سرور

بدنه درخواست

titlestring
عنوان (اختیاری)حداقل 2 کاراکتر · حداکثر 120 کاراکتر
bodystringrequired
متن خبر؛ HTML حذف می‌شودحداقل 2 کاراکتر · حداکثر 5000 کاراکتر
imageUrlstring
نشانی تصویری که قبلاً در پنل بارگذاری شده استحداکثر 500 کاراکتر
linkstring
پیوند بیشتر بخوانیدحداکثر 500 کاراکتر · قالب uri

پاسخ 201

idstring
sourcestring
یکی از: "telegram"، "discord"، "instagram"، "internal"
titlestring | null
bodystring
imageUrlstring | null
linkstring | null
publishedAtstring
زمان به قالب ISO 8601 (UTC)

خطاهای ممکن

400ورودی نامعتبر
401کلید ارسال نشده، نامعتبر یا باطل‌شده
403کلید دسترسی لازم را ندارد
404سرور یا مورد درخواستی یافت نشد
429سقف درخواست در دقیقه پر شده است

curl -X POST "https://gameroute.ir/api/v1/servers/iran-craft/news" \
  -H "Authorization: Bearer gr_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"فصل جدید شروع شد","body":"نقشه جدید و جوایز هفتگی از امشب فعال است.","link":"https://irancraft.ir/season-5"}'

نمونه پاسخ 201

{
  "id": "cm3n2k8x40001",
  "source": "internal",
  "title": "فصل جدید شروع شد",
  "body": "نقشه جدید و جوایز هفتگی از امشب فعال است.",
  "imageUrl": null,
  "link": "https://irancraft.ir/season-5",
  "publishedAt": "2026-10-30T16:00:00.000Z"
}

امتحان کنیداین مسیر کلید لازم دارد

server *path

بدنه JSON

ابتدا کلید را در بالای صفحه وارد کنید.

ویرایش خبر#

PATCH/api/v1/servers/{server}/news/{newsId}

دسترسی: news:writeکلید API لازم است

فقط پست‌های داخلی ویرایش می‌شوند؛ موارد همگام‌شده از تلگرام یا دیسکورد را منبع خودشان مدیریت می‌کند. فیلدهای ارسال‌نشده تغییر نمی‌کنند و null مقدار را پاک می‌کند.

پارامترها

serverstringpathrequired
نامک (slug) یا شناسه سرور
newsIdstringpathrequired
شناسه خبر

بدنه درخواست

titlestring | null
عنوان (اختیاری)حداقل 2 کاراکتر · حداکثر 120 کاراکتر
bodystring
متن خبر؛ HTML حذف می‌شودحداقل 2 کاراکتر · حداکثر 5000 کاراکتر
imageUrlstring | null
نشانی تصویری که قبلاً در پنل بارگذاری شده استحداکثر 500 کاراکتر
linkstring | null
پیوند بیشتر بخوانیدحداکثر 500 کاراکتر · قالب uri

پاسخ 200

idstring
sourcestring
یکی از: "telegram"، "discord"، "instagram"، "internal"
titlestring | null
bodystring
imageUrlstring | null
linkstring | null
publishedAtstring
زمان به قالب ISO 8601 (UTC)

خطاهای ممکن

400ورودی نامعتبر
401کلید ارسال نشده، نامعتبر یا باطل‌شده
403کلید دسترسی لازم را ندارد
404سرور یا مورد درخواستی یافت نشد
429سقف درخواست در دقیقه پر شده است

curl -X PATCH "https://gameroute.ir/api/v1/servers/iran-craft/news/cm3n2k8x40001" \
  -H "Authorization: Bearer gr_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"فصل پنجم شروع شد","link":null}'

نمونه پاسخ 200

{
  "id": "cm3n2k8x40001",
  "source": "internal",
  "title": "فصل پنجم شروع شد",
  "body": "نقشه جدید و جوایز هفتگی از امشب فعال است.",
  "imageUrl": null,
  "link": null,
  "publishedAt": "2026-10-30T16:00:00.000Z"
}

امتحان کنیداین مسیر کلید لازم دارد

server *pathnewsId *path

بدنه JSON

ابتدا کلید را در بالای صفحه وارد کنید.

حذف خبر#

DELETE/api/v1/servers/{server}/news/{newsId}

دسترسی: news:writeکلید API لازم است

یک پست داخلی را حذف می‌کند. پاسخ موفق بدنه ندارد.

پارامترها

serverstringpathrequired
نامک (slug) یا شناسه سرور
newsIdstringpathrequired
شناسه خبر

پاسخ 204

پاسخ موفق بدنه ندارد.

خطاهای ممکن

401کلید ارسال نشده، نامعتبر یا باطل‌شده
403کلید دسترسی لازم را ندارد
404سرور یا مورد درخواستی یافت نشد
429سقف درخواست در دقیقه پر شده است

curl -X DELETE "https://gameroute.ir/api/v1/servers/iran-craft/news/cm3n2k8x40001" \
  -H "Authorization: Bearer gr_live_YOUR_KEY"

امتحان کنیداین مسیر کلید لازم دارد

server *pathnewsId *path

ابتدا کلید را در بالای صفحه وارد کنید.

مدیریت سرور

ویرایش اطلاعات سرور با کلید مخصوص همان سرور

ویرایش اطلاعات سرور#

PATCH/api/v1/servers/{server}/profile

دسترسی: profile:writeکلید API لازم است

فیلدهای متنی صفحه سرور را تغییر می‌دهد. سازنده کلید باید دسترسی «ویرایش اطلاعات سرور» را داشته باشد. تصاویر و تنظیمات نظرات فقط از پنل تغییر می‌کنند. socials و tags به‌طور کامل جایگزین می‌شوند.

پارامترها

serverstringpathrequired
نامک (slug) یا شناسه سرور

بدنه درخواست

namestring
نام سرورحداقل 2 کاراکتر · حداکثر 60 کاراکتر
shortDescriptionstring | null
توضیح کوتاه زیر نام (تا ۱۶۰ کاراکتر)حداکثر 160 کاراکتر
descriptionstring | null
توضیحات کامل به Markdownحداکثر 20000 کاراکتر
displayAddressstring | null
آدرس نمایشی به جای host:portحداکثر 120 کاراکتر
colorstring | null
رنگ اصلی صفحه سرور به شکل #RRGGBBالگو ^#[0-9a-fA-F]{6}$
socialsobject
پیوند شبکه‌های اجتماعی؛ کل شیء جایگزین می‌شود
websitestring
حداکثر 200 کاراکتر
discordstring
حداکثر 200 کاراکتر
telegramstring
حداکثر 200 کاراکتر
instagramstring
حداکثر 200 کاراکتر
youtubestring
حداکثر 200 کاراکتر
aparatstring
حداکثر 200 کاراکتر
rubikastring
حداکثر 200 کاراکتر
balestring
حداکثر 200 کاراکتر
teamspeakstring
حداکثر 200 کاراکتر
tagsarray<string>
برچسب‌ها (حداکثر ۸)؛ کل فهرست جایگزین می‌شود
seoTitlestring | null
عنوان سئو (تا ۷۰ کاراکتر)حداکثر 70 کاراکتر
seoDescriptionstring | null
توضیح سئو (تا ۱۷۰ کاراکتر)حداکثر 170 کاراکتر

پاسخ 200

changedarray<string>
فیلدهایی که مقدارشان واقعاً تغییر کرد

خطاهای ممکن

400ورودی نامعتبر
401کلید ارسال نشده، نامعتبر یا باطل‌شده
403کلید دسترسی لازم را ندارد
404سرور یا مورد درخواستی یافت نشد
429سقف درخواست در دقیقه پر شده است

curl -X PATCH "https://gameroute.ir/api/v1/servers/iran-craft/profile" \
  -H "Authorization: Bearer gr_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"shortDescription":"سروایول، اسکای‌بلاک و رویداد هفتگی","tags":["survival","skyblock","event"]}'

نمونه پاسخ 200

{
  "changed": [
    "shortDescription",
    "tags"
  ]
}

امتحان کنیداین مسیر کلید لازم دارد

server *path

بدنه JSON

ابتدا کلید را در بالای صفحه وارد کنید.

کلید و حساب

اطلاعات کلید فعلی و فهرست بازی‌ها

اطلاعات کلید فعلی#

GET/api/v1/me

دسترسی: readکلید API لازم است

نام، دسترسی‌ها، سقف درخواست و سرور متصل به کلیدی که با آن درخواست را فرستاده‌اید. برای آزمایش درستی کلید مناسب است.

پاسخ 200

keyobject
prefixstring
namestring
scopesarray<string>
rateLimitinteger
سقف درخواست در دقیقه
serverobject | null
idstring
slugstring
namestring
userobject
usernamestring

خطاهای ممکن

401کلید ارسال نشده، نامعتبر یا باطل‌شده
429سقف درخواست در دقیقه پر شده است

curl "https://gameroute.ir/api/v1/me" \
  -H "Authorization: Bearer gr_live_YOUR_KEY"

نمونه پاسخ 200

{
  "key": {
    "prefix": "gr_live_ab12cd",
    "name": "ربات دیسکورد",
    "scopes": [
      "read",
      "news:write"
    ],
    "rateLimit": 120,
    "server": {
      "id": "cm2x7v1q30000abcd",
      "slug": "iran-craft",
      "name": "Iran Craft"
    }
  },
  "user": {
    "username": "ali"
  }
}

امتحان کنیداین مسیر کلید لازم دارد

ابتدا کلید را در بالای صفحه وارد کنید.

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

GET/api/v1/games

دسترسی: readبدون کلید هم کار می‌کند

بازی‌هایی که گیم روت پشتیبانی می‌کند، با شناسه‌ای که در پارامتر game استفاده می‌شود و پورت پیش‌فرض.

پاسخ 200

خطاهای ممکن

429سقف درخواست در دقیقه پر شده است

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

نمونه پاسخ 200

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

امتحان کنیدبدون کلید (سقف کمتر)

ابزارک‌ها

بنرهای تصویری وضعیت سرور برای انجمن‌ها و سایت‌ها

بنر وضعیت سرور#

GET/api/v1/widgets/{server}/{file}

دسترسی: readکلید API لازم است

تصویر SVG یا PNG با وضعیت و تعداد بازیکنان. file یکی از badge، banner، card یا leaderboard با پسوند .svg یا .png است. نیازی به کلید ندارد و یک دقیقه کش می‌شود.

پارامترها

serverstringpathrequired
نامک یا شناسه سرور
filestringpathrequired
themestringquery
یکی از: dark، light، accent · پیش‌فرض: dark

پاسخ 200

خطاهای ممکن

404سرور یافت نشد (همچنان یک تصویر برمی‌گردد)

curl "https://gameroute.ir/api/v1/widgets/iran-craft/banner.png" \
  -H "Authorization: Bearer gr_live_YOUR_KEY"

امتحان کنیداین مسیر کلید لازم دارد

server *pathfile *paththemequery

ابتدا کلید را در بالای صفحه وارد کنید.

توسعه‌دهندگان

مرجع API

کلید API برای «امتحان کنید»

سرورها

فهرست، جست‌وجو و جزئیات سرورهای تأییدشده

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

GET/api/v1/servers

دسترسی: readبدون کلید هم کار می‌کند

پارامترها

gamestringquery
شناسه بازی: mta، vmp یا minecraftیکی از: mta، vmp، minecraft
qstringquery
جست‌وجو در نام، آدرس و برچسب‌ها
tagstringquery
فقط سرورهای دارای این برچسب
editionstringquery
یکی از: java، bedrock
sortstringquery
ترتیب: rank (رتبه سایت)، players، rating یا newیکی از: rank، players، record، name، votes، rating، new، old · پیش‌فرض: rank
dirstringquery
یکی از: asc، desc
pageintegerquery
شماره صفحه، از ۱پیش‌فرض: 1
pageSizeintegerquery
تعداد مورد در هر صفحهپیش‌فرض: 24 · حداکثر 60

پاسخ 200

itemsarray<object>
idstring
slugstring
urlstring
نشانی صفحه سرور در گیم روت
gamestring
یکی از: "mta"، "vmp"، "minecraft"
namestring
shortDescriptionstring | null
addressstring
آدرس اتصال، همان‌طور که بازیکن وارد می‌کند
hoststring
portinteger
tagsarray<string>
verifiedboolean
sponsoredboolean
rankinteger | null
جایگاه در رتبه‌بندی؛ فقط با sort=rank
boostobject
countinteger
levelinteger
ratingobject
averagenumber
countinteger
recordobject
playersinteger
atstring | null
زمان به قالب ISO 8601 (UTC)
brandingobject
colorstring | null
logoUrlstring | null
bannerUrlstring | null
badgesarray<object>
keystring
namestring
descriptionstring
iconstring
colorstring
awardedAtstring
زمان به قالب ISO 8601 (UTC)
detailstring | null
liveobject | null
onlineboolean
playersinteger
maxPlayersinteger
rttMsinteger | null
زمان رفت‌وبرگشت از گیم روت تا سرور بازی (میلی‌ثانیه)
versionstring | null
mapstring | null
gamemodestring | null
queriedAtstring
زمان به قالب ISO 8601 (UTC)
totalinteger
pageinteger
pageSizeinteger
hasMoreboolean

خطاهای ممکن

400ورودی نامعتبر
429سقف درخواست در دقیقه پر شده است

curl "https://gameroute.ir/api/v1/servers"

نمونه پاسخ 200

{
  "items": [
    {
      "id": "cm2x7v1q30000abcd",
      "slug": "iran-craft",
      "url": "https://gameroute.ir/servers/iran-craft",
      "game": "minecraft",
      "name": "Iran Craft",
      "shortDescription": "سرور سروایول و اسکای‌بلاک با اقتصاد فعال",
      "address": "play.irancraft.ir",
      "host": "play.irancraft.ir",
      "port": 25565,
      "tags": [
        "survival",
        "skyblock"
      ],
      "verified": true,
      "sponsored": false,
      "rank": 1,
      "boost": {
        "count": 3,
        "level": 1
      },
      "rating": {
        "average": 4.6,
        "count": 87
      },
      "record": {
        "players": 612,
        "at": "2026-09-12T18:00:00.000Z"
      },
      "branding": {
        "color": "#36FFA8",
        "logoUrl": "https://gameroute.ir/media/logo/ab12.webp",
        "bannerUrl": null
      },
      "badges": [
        {
          "key": "record-500",
          "name": "رکورددار",
          "description": "رکورد ۵۰۰ بازیکن همزمان",
          "icon": "trophy",
          "color": "#F5A524",
          "awardedAt": "2026-09-12T18:00:00.000Z",
          "detail": "رکورد ۶۱۲ بازیکن همزمان"
        }
      ],
      "live": {
        "online": true,
        "players": 128,
        "maxPlayers": 300,
        "rttMs": 34,
        "version": "1.21.1",
        "map": null,
        "gamemode": "Survival",
        "queriedAt": "2026-10-31T09:41:00.000Z"
      }
    }
  ],
  "total": 214,
  "page": 1,
  "pageSize": 24,
  "hasMore": true
}

امتحان کنیدبدون کلید (سقف کمتر)

gamequery

qquerytagqueryeditionquery

sortquery

dirquery

pagequerypageSizequery

جزئیات سرور#

GET/api/v1/servers/{server}

دسترسی: readبدون کلید هم کار می‌کند

همه اطلاعات عمومی صفحه سرور: توضیحات (Markdown)، شبکه‌های اجتماعی، گالری، ویدیوها، آپتایم ۳۰ روزه و وضعیت زنده.

پارامترها

serverstringpathrequired
نامک (slug) یا شناسه سرور

پاسخ 200

idstring
slugstring
urlstring
نشانی صفحه سرور در گیم روت
gamestring
یکی از: "mta"، "vmp"، "minecraft"
namestring
shortDescriptionstring | null
addressstring
آدرس اتصال، همان‌طور که بازیکن وارد می‌کند
hoststring
portinteger
tagsarray<string>
verifiedboolean
sponsoredboolean
rankinteger | null
جایگاه در رتبه‌بندی؛ فقط با sort=rank
boostobject
countinteger
levelinteger
ratingobject
averagenumber
countinteger
recordobject
playersinteger
atstring | null
زمان به قالب ISO 8601 (UTC)
brandingobject
colorstring | null
logoUrlstring | null
bannerUrlstring | null
badgesarray<object>
keystring
namestring
descriptionstring
iconstring
colorstring
awardedAtstring
زمان به قالب ISO 8601 (UTC)
detailstring | null
liveobject | null
onlineboolean
playersinteger
maxPlayersinteger
rttMsinteger | null
زمان رفت‌وبرگشت از گیم روت تا سرور بازی (میلی‌ثانیه)
versionstring | null
mapstring | null
gamemodestring | null
queriedAtstring
زمان به قالب ISO 8601 (UTC)
descriptionstring | null
توضیحات کامل به Markdown
socialsobject
createdAtstring
زمان به قالب ISO 8601 (UTC)
uptime30dnumber | null
درصد آپتایم ۳۰ روز اخیر (۰ تا ۱۰۰)
ownerobject | null
usernamestring
displayNamestring | null
galleryarray<object>
urlstring
captionstring | null
videosarray<object>
providerstring
یکی از: "youtube"، "aparat"، "upload"
urlstring
titlestring | null

خطاهای ممکن

404سرور یا مورد درخواستی یافت نشد
429سقف درخواست در دقیقه پر شده است

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

نمونه پاسخ 200

{
  "id": "cm2x7v1q30000abcd",
  "slug": "iran-craft",
  "url": "https://gameroute.ir/servers/iran-craft",
  "game": "minecraft",
  "name": "Iran Craft",
  "shortDescription": "سرور سروایول و اسکای‌بلاک با اقتصاد فعال",
  "address": "play.irancraft.ir",
  "host": "play.irancraft.ir",
  "port": 25565,
  "tags": [
    "survival",
    "skyblock"
  ],
  "verified": true,
  "sponsored": false,
  "rank": 1,
  "boost": {
    "count": 3,
    "level": 1
  },
  "rating": {
    "average": 4.6,
    "count": 87
  },
  "record": {
    "players": 612,
    "at": "2026-09-12T18:00:00.000Z"
  },
  "branding": {
    "color": "#36FFA8",
    "logoUrl": "https://gameroute.ir/media/logo/ab12.webp",
    "bannerUrl": null
  },
  "badges": [
    {
      "key": "record-500",
      "name": "رکورددار",
      "description": "رکورد ۵۰۰ بازیکن همزمان",
      "icon": "trophy",
      "color": "#F5A524",
      "awardedAt": "2026-09-12T18:00:00.000Z",
      "detail": "رکورد ۶۱۲ بازیکن همزمان"
    }
  ],
  "live": {
    "online": true,
    "players": 128,
    "maxPlayers": 300,
    "rttMs": 34,
    "version": "1.21.1",
    "map": null,
    "gamemode": "Survival",
    "queriedAt": "2026-10-31T09:41:00.000Z"
  },
  "description": "## درباره سرور\nسروایول بدون لگ با پشتیبانی ۲۴ ساعته.",
  "socials": {
    "discord": "https://discord.gg/irancraft",
    "telegram": "https://t.me/irancraft"
  },
  "createdAt": "2026-03-02T10:00:00.000Z",
  "uptime30d": 99.2,
  "owner": {
    "username": "ali",
    "displayName": "علی"
  },
  "gallery": [],
  "videos": []
}

امتحان کنیدبدون کلید (سقف کمتر)

server *path

وضعیت زنده و آمار

وضعیت لحظه‌ای، بازیکنان، نمودار تاریخچه، رکوردها و نشان‌ها

وضعیت زنده#

GET/api/v1/servers/{server}/status

دسترسی: readبدون کلید هم کار می‌کند

پارامترها

serverstringpathrequired
نامک (slug) یا شناسه سرور

پاسخ 200

onlineboolean
playersinteger
maxPlayersinteger
rttMsinteger | null
زمان رفت‌وبرگشت از گیم روت تا سرور بازی (میلی‌ثانیه)
versionstring | null
mapstring | null
gamemodestring | null
queriedAtstring
زمان به قالب ISO 8601 (UTC)
serverIdstring
slugstring
staleboolean
اگر آخرین کوئری قدیمی‌تر از ۳ دقیقه باشد true است

خطاهای ممکن

404سرور یا مورد درخواستی یافت نشد
429سقف درخواست در دقیقه پر شده است

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

نمونه پاسخ 200

{
  "serverId": "cm2x7v1q30000abcd",
  "slug": "iran-craft",
  "online": true,
  "players": 128,
  "maxPlayers": 300,
  "rttMs": 34,
  "version": "1.21.1",
  "map": null,
  "gamemode": "Survival",
  "queriedAt": "2026-10-31T09:41:00.000Z",
  "stale": false
}

امتحان کنیدبدون کلید (سقف کمتر)

server *path

بازیکنان آنلاین#

GET/api/v1/servers/{server}/players

دسترسی: readبدون کلید هم کار می‌کند

پارامترها

serverstringpathrequired
نامک (slug) یا شناسه سرور

پاسخ 200

onlineinteger
تعداد بازیکنان آنلاین در آخرین کوئری
itemsarray<object>
namestring
scorenumber | null
pingnumber | null
partialboolean
بعضی بازی‌ها (ماینکرفت) فقط نمونه‌ای از نام‌ها را می‌فرستند
queriedAtstring | null
زمان به قالب ISO 8601 (UTC)

خطاهای ممکن

404سرور یا مورد درخواستی یافت نشد
429سقف درخواست در دقیقه پر شده است

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

نمونه پاسخ 200

{
  "online": 3,
  "items": [
    {
      "name": "Sina",
      "score": 42,
      "ping": 51
    },
    {
      "name": "Neda",
      "score": 17,
      "ping": 38
    },
    {
      "name": "Kian",
      "score": 5,
      "ping": 77
    }
  ],
  "partial": false,
  "queriedAt": "2026-10-31T09:41:00.000Z"
}

امتحان کنیدبدون کلید (سقف کمتر)

server *path

تاریخچه بازیکنان#

GET/api/v1/servers/{server}/stats

دسترسی: readبدون کلید هم کار می‌کند

پارامترها

serverstringpathrequired
نامک (slug) یا شناسه سرور
rangestringquery
بازه زمانی نموداریکی از: 24h، 7d، 30d · پیش‌فرض: 24h

پاسخ 200

rangestring
یکی از: "24h"، "7d"، "30d"
resolutionstring
یکی از: "raw"، "hour"، "day"
pointsarray<object>
tstring
زمان به قالب ISO 8601 (UTC)
playersinteger
میانگین بازیکنان در این بازه
maxinteger
بیشترین بازیکن در این بازه
summaryobject
avgPlayersnumber | null
peakPlayersinteger | null
uptimePctnumber | null

خطاهای ممکن

400ورودی نامعتبر
404سرور یا مورد درخواستی یافت نشد
429سقف درخواست در دقیقه پر شده است

curl "https://gameroute.ir/api/v1/servers/iran-craft/stats?range=7d"

نمونه پاسخ 200

{
  "range": "7d",
  "resolution": "hour",
  "points": [
    {
      "t": "2026-10-30T18:00:00.000Z",
      "players": 141,
      "max": 163
    },
    {
      "t": "2026-10-30T19:00:00.000Z",
      "players": 172,
      "max": 190
    }
  ],
  "summary": {
    "avgPlayers": 156.5,
    "peakPlayers": 190,
    "uptimePct": 99.6
  }
}

امتحان کنیدبدون کلید (سقف کمتر)

server *pathrangequery

رکوردها#

GET/api/v1/servers/{server}/records

دسترسی: readبدون کلید هم کار می‌کند

رکورد همیشگی بازیکنان همزمان و بیشترین تعداد بازیکن در ۲۴ ساعت، ۷ روز و ۳۰ روز گذشته.

پارامترها

serverstringpathrequired
نامک (slug) یا شناسه سرور

پاسخ 200

allTimeobject
playersinteger
atstring | null
زمان به قالب ISO 8601 (UTC)
peak24hobject | null
playersinteger
atstring
زمان به قالب ISO 8601 (UTC)
peak7dobject | null
playersinteger
atstring
زمان به قالب ISO 8601 (UTC)
peak30dobject | null
playersinteger
atstring
زمان به قالب ISO 8601 (UTC)

خطاهای ممکن

404سرور یا مورد درخواستی یافت نشد
429سقف درخواست در دقیقه پر شده است

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

نمونه پاسخ 200

{
  "allTime": {
    "players": 612,
    "at": "2026-09-12T18:00:00.000Z"
  },
  "peak24h": {
    "players": 190,
    "at": "2026-10-30T19:12:00.000Z"
  },
  "peak7d": {
    "players": 233,
    "at": "2026-10-27T20:00:00.000Z"
  },
  "peak30d": {
    "players": 301,
    "at": "2026-10-10T00:00:00.000Z"
  }
}

امتحان کنیدبدون کلید (سقف کمتر)

server *path

نشان‌ها#

GET/api/v1/servers/{server}/badges

دسترسی: readبدون کلید هم کار می‌کند

نشان‌هایی که سرور گرفته است، به ترتیب اولویت نمایش.

پارامترها

serverstringpathrequired
نامک (slug) یا شناسه سرور

پاسخ 200

itemsarray<object>
keystring
namestring
descriptionstring
iconstring
colorstring
awardedAtstring
زمان به قالب ISO 8601 (UTC)
detailstring | null

خطاهای ممکن

404سرور یا مورد درخواستی یافت نشد
429سقف درخواست در دقیقه پر شده است

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

نمونه پاسخ 200

{
  "items": [
    {
      "key": "record-500",
      "name": "رکورددار",
      "description": "رکورد ۵۰۰ بازیکن همزمان",
      "icon": "trophy",
      "color": "#F5A524",
      "awardedAt": "2026-09-12T18:00:00.000Z",
      "detail": "رکورد ۶۱۲ بازیکن همزمان"
    }
  ]
}

امتحان کنیدبدون کلید (سقف کمتر)

server *path

اخبار

خواندن و مدیریت اخبار سرور

اخبار سرور#

GET/api/v1/servers/{server}/news

دسترسی: readبدون کلید هم کار می‌کند

خبرهای سرور از جدید به قدیم: پست‌های داخلی تیم و موارد منابع متصل.

پارامترها

serverstringpathrequired
نامک (slug) یا شناسه سرور
pageintegerquery
شماره صفحه، از ۱پیش‌فرض: 1
pageSizeintegerquery
تعداد مورد در هر صفحهپیش‌فرض: 20 · حداکثر 50

پاسخ 200

itemsarray<object>
idstring
sourcestring
یکی از: "telegram"، "discord"، "instagram"، "internal"
titlestring | null
bodystring
imageUrlstring | null
linkstring | null
publishedAtstring
زمان به قالب ISO 8601 (UTC)
totalinteger
pageinteger
pageSizeinteger
hasMoreboolean

خطاهای ممکن

400ورودی نامعتبر
404سرور یا مورد درخواستی یافت نشد
429سقف درخواست در دقیقه پر شده است

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

نمونه پاسخ 200

{
  "items": [
    {
      "id": "cm3n2k8x40001",
      "source": "internal",
      "title": "فصل جدید شروع شد",
      "body": "نقشه جدید و جوایز هفتگی از امشب فعال است.",
      "imageUrl": null,
      "link": "https://irancraft.ir/season-5",
      "publishedAt": "2026-10-30T16:00:00.000Z"
    }
  ],
  "total": 12,
  "page": 1,
  "pageSize": 20,
  "hasMore": false
}

امتحان کنیدبدون کلید (سقف کمتر)

server *pathpagequerypageSizequery

انتشار خبر#

POST/api/v1/servers/{server}/news

دسترسی: news:writeکلید API لازم است

پارامترها

serverstringpathrequired
نامک (slug) یا شناسه سرور

بدنه درخواست

titlestring
عنوان (اختیاری)حداقل 2 کاراکتر · حداکثر 120 کاراکتر
bodystringrequired
متن خبر؛ HTML حذف می‌شودحداقل 2 کاراکتر · حداکثر 5000 کاراکتر
imageUrlstring
نشانی تصویری که قبلاً در پنل بارگذاری شده استحداکثر 500 کاراکتر
linkstring
پیوند بیشتر بخوانیدحداکثر 500 کاراکتر · قالب uri

پاسخ 201

idstring
sourcestring
یکی از: "telegram"، "discord"، "instagram"، "internal"
titlestring | null
bodystring
imageUrlstring | null
linkstring | null
publishedAtstring
زمان به قالب ISO 8601 (UTC)

خطاهای ممکن

400ورودی نامعتبر
401کلید ارسال نشده، نامعتبر یا باطل‌شده
403کلید دسترسی لازم را ندارد
404سرور یا مورد درخواستی یافت نشد
429سقف درخواست در دقیقه پر شده است

curl -X POST "https://gameroute.ir/api/v1/servers/iran-craft/news" \
  -H "Authorization: Bearer gr_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"فصل جدید شروع شد","body":"نقشه جدید و جوایز هفتگی از امشب فعال است.","link":"https://irancraft.ir/season-5"}'

نمونه پاسخ 201

{
  "id": "cm3n2k8x40001",
  "source": "internal",
  "title": "فصل جدید شروع شد",
  "body": "نقشه جدید و جوایز هفتگی از امشب فعال است.",
  "imageUrl": null,
  "link": "https://irancraft.ir/season-5",
  "publishedAt": "2026-10-30T16:00:00.000Z"
}

امتحان کنیداین مسیر کلید لازم دارد

server *path

بدنه JSON

ابتدا کلید را در بالای صفحه وارد کنید.

ویرایش خبر#

PATCH/api/v1/servers/{server}/news/{newsId}

دسترسی: news:writeکلید API لازم است

پارامترها

serverstringpathrequired
نامک (slug) یا شناسه سرور
newsIdstringpathrequired
شناسه خبر

بدنه درخواست

titlestring | null
عنوان (اختیاری)حداقل 2 کاراکتر · حداکثر 120 کاراکتر
bodystring
متن خبر؛ HTML حذف می‌شودحداقل 2 کاراکتر · حداکثر 5000 کاراکتر
imageUrlstring | null
نشانی تصویری که قبلاً در پنل بارگذاری شده استحداکثر 500 کاراکتر
linkstring | null
پیوند بیشتر بخوانیدحداکثر 500 کاراکتر · قالب uri

پاسخ 200

idstring
sourcestring
یکی از: "telegram"، "discord"، "instagram"، "internal"
titlestring | null
bodystring
imageUrlstring | null
linkstring | null
publishedAtstring
زمان به قالب ISO 8601 (UTC)

خطاهای ممکن

400ورودی نامعتبر
401کلید ارسال نشده، نامعتبر یا باطل‌شده
403کلید دسترسی لازم را ندارد
404سرور یا مورد درخواستی یافت نشد
429سقف درخواست در دقیقه پر شده است

curl -X PATCH "https://gameroute.ir/api/v1/servers/iran-craft/news/cm3n2k8x40001" \
  -H "Authorization: Bearer gr_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"فصل پنجم شروع شد","link":null}'

نمونه پاسخ 200

{
  "id": "cm3n2k8x40001",
  "source": "internal",
  "title": "فصل پنجم شروع شد",
  "body": "نقشه جدید و جوایز هفتگی از امشب فعال است.",
  "imageUrl": null,
  "link": null,
  "publishedAt": "2026-10-30T16:00:00.000Z"
}

امتحان کنیداین مسیر کلید لازم دارد

server *pathnewsId *path

بدنه JSON

ابتدا کلید را در بالای صفحه وارد کنید.

حذف خبر#

DELETE/api/v1/servers/{server}/news/{newsId}

دسترسی: news:writeکلید API لازم است

یک پست داخلی را حذف می‌کند. پاسخ موفق بدنه ندارد.

پارامترها

serverstringpathrequired
نامک (slug) یا شناسه سرور
newsIdstringpathrequired
شناسه خبر

پاسخ 204

پاسخ موفق بدنه ندارد.

خطاهای ممکن

401کلید ارسال نشده، نامعتبر یا باطل‌شده
403کلید دسترسی لازم را ندارد
404سرور یا مورد درخواستی یافت نشد
429سقف درخواست در دقیقه پر شده است

curl -X DELETE "https://gameroute.ir/api/v1/servers/iran-craft/news/cm3n2k8x40001" \
  -H "Authorization: Bearer gr_live_YOUR_KEY"

امتحان کنیداین مسیر کلید لازم دارد

server *pathnewsId *path

ابتدا کلید را در بالای صفحه وارد کنید.

مدیریت سرور

ویرایش اطلاعات سرور با کلید مخصوص همان سرور

ویرایش اطلاعات سرور#

PATCH/api/v1/servers/{server}/profile

دسترسی: profile:writeکلید API لازم است

پارامترها

serverstringpathrequired
نامک (slug) یا شناسه سرور

بدنه درخواست

namestring
نام سرورحداقل 2 کاراکتر · حداکثر 60 کاراکتر
shortDescriptionstring | null
توضیح کوتاه زیر نام (تا ۱۶۰ کاراکتر)حداکثر 160 کاراکتر
descriptionstring | null
توضیحات کامل به Markdownحداکثر 20000 کاراکتر
displayAddressstring | null
آدرس نمایشی به جای host:portحداکثر 120 کاراکتر
colorstring | null
رنگ اصلی صفحه سرور به شکل #RRGGBBالگو ^#[0-9a-fA-F]{6}$
socialsobject
پیوند شبکه‌های اجتماعی؛ کل شیء جایگزین می‌شود
websitestring
حداکثر 200 کاراکتر
discordstring
حداکثر 200 کاراکتر
telegramstring
حداکثر 200 کاراکتر
instagramstring
حداکثر 200 کاراکتر
youtubestring
حداکثر 200 کاراکتر
aparatstring
حداکثر 200 کاراکتر
rubikastring
حداکثر 200 کاراکتر
balestring
حداکثر 200 کاراکتر
teamspeakstring
حداکثر 200 کاراکتر
tagsarray<string>
برچسب‌ها (حداکثر ۸)؛ کل فهرست جایگزین می‌شود
seoTitlestring | null
عنوان سئو (تا ۷۰ کاراکتر)حداکثر 70 کاراکتر
seoDescriptionstring | null
توضیح سئو (تا ۱۷۰ کاراکتر)حداکثر 170 کاراکتر

پاسخ 200

changedarray<string>
فیلدهایی که مقدارشان واقعاً تغییر کرد

خطاهای ممکن

400ورودی نامعتبر
401کلید ارسال نشده، نامعتبر یا باطل‌شده
403کلید دسترسی لازم را ندارد
404سرور یا مورد درخواستی یافت نشد
429سقف درخواست در دقیقه پر شده است

curl -X PATCH "https://gameroute.ir/api/v1/servers/iran-craft/profile" \
  -H "Authorization: Bearer gr_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"shortDescription":"سروایول، اسکای‌بلاک و رویداد هفتگی","tags":["survival","skyblock","event"]}'

نمونه پاسخ 200

{
  "changed": [
    "shortDescription",
    "tags"
  ]
}

امتحان کنیداین مسیر کلید لازم دارد

server *path

بدنه JSON

ابتدا کلید را در بالای صفحه وارد کنید.

کلید و حساب

اطلاعات کلید فعلی و فهرست بازی‌ها

اطلاعات کلید فعلی#

GET/api/v1/me

دسترسی: readکلید API لازم است

پاسخ 200

keyobject
prefixstring
namestring
scopesarray<string>
rateLimitinteger
سقف درخواست در دقیقه
serverobject | null
idstring
slugstring
namestring
userobject
usernamestring

خطاهای ممکن

401کلید ارسال نشده، نامعتبر یا باطل‌شده
429سقف درخواست در دقیقه پر شده است

curl "https://gameroute.ir/api/v1/me" \
  -H "Authorization: Bearer gr_live_YOUR_KEY"

نمونه پاسخ 200

{
  "key": {
    "prefix": "gr_live_ab12cd",
    "name": "ربات دیسکورد",
    "scopes": [
      "read",
      "news:write"
    ],
    "rateLimit": 120,
    "server": {
      "id": "cm2x7v1q30000abcd",
      "slug": "iran-craft",
      "name": "Iran Craft"
    }
  },
  "user": {
    "username": "ali"
  }
}

امتحان کنیداین مسیر کلید لازم دارد

ابتدا کلید را در بالای صفحه وارد کنید.

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

GET/api/v1/games

دسترسی: readبدون کلید هم کار می‌کند

بازی‌هایی که گیم روت پشتیبانی می‌کند، با شناسه‌ای که در پارامتر game استفاده می‌شود و پورت پیش‌فرض.

پاسخ 200

خطاهای ممکن

429سقف درخواست در دقیقه پر شده است

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

نمونه پاسخ 200

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

امتحان کنیدبدون کلید (سقف کمتر)

ابزارک‌ها

بنرهای تصویری وضعیت سرور برای انجمن‌ها و سایت‌ها

بنر وضعیت سرور#

GET/api/v1/widgets/{server}/{file}

دسترسی: readکلید API لازم است

پارامترها

serverstringpathrequired
نامک یا شناسه سرور
filestringpathrequired
themestringquery
یکی از: dark، light، accent · پیش‌فرض: dark

پاسخ 200

خطاهای ممکن

404سرور یافت نشد (همچنان یک تصویر برمی‌گردد)

curl "https://gameroute.ir/api/v1/widgets/iran-craft/banner.png" \
  -H "Authorization: Bearer gr_live_YOUR_KEY"

امتحان کنیداین مسیر کلید لازم دارد

server *pathfile *paththemequery

ابتدا کلید را در بالای صفحه وارد کنید.