📂سرور

مستندات مربوط به API اطلاعات سرور ها

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


🔹 تمامی سرورها

این endpoint لیست تمامی سرورهای ثبت ‌شده در گیم تولز را برمی‌گرداند.

پارامترنوع دادهتوضیحات
--هیچ پارامتری لازم نیست. این endpoint تمام سرورها را به صورت یک لیست برمی‌گرداند.

🔹 سرورهای هر بخش

این endpoint لیست تمامی سرورهای ثبت ‌شده در هر بخش گیم تولز را برمی‌گرداند.

پارامترنوع دادهتوضیحات
categorystringدسته‌بندی سرور مورد نظر؛ مانند mc برای Minecraft، fivem برای FiveM، و mta برای MTA.

🔹 سرور

این endpoint لیست مشخصات هر سرور ثبت شده در گیم تولز را برمی‌گرداند.

پارامترنوع دادهتوضیحات
categorystringدسته‌بندی سرور مورد نظر؛ مانند mc برای Minecraft، fivem برای FiveM، و mta برای MTA.
serverNamestringنام سرور مورد نظر که می‌تواند به عنوان serverName شناخته شود. همچنین می‌تواند به عنوان IP آدرس یا دامنه (در صورت وجود) نیز استفاده شود.

اگر IP یا دامنه به عنوان serverName وارد شود، اطلاعات مربوط به آن سرور بازگردانده خواهد شد.


📊 مقادیر برگشتی از سرور ها

این جدول مقادیر برگشتی سرور ها را با نوع هر مقدار و توضیحات مربوط به آن نمایش می‌دهد.

در صورت داشتن ? در کنار نوع داده، این مقدار ممکن است null باشد.

کلیدنوعتوضیحات
idnumberشناسه منحصر به فرد سرور
namestringنام سرور
descriptionstring?توضیحات مربوط به سرور
categorystringدسته‌بندی سرور
addressstringآدرس سرور
ipstringآدرس IP سرور
locationstring?موقعیت سرور (فقط در صورت آنلاین بودن)
uptimenumber?زمان آنلاین بودن سرور (فقط در صورت آنلاین بودن)
downtimenumber?زمان عدم آنلاین بودن سرور (فقط در صورت غیر آنلاین بودن)
trackedAtstringتاریخ و زمان آخرین به‌روزرسانی اطلاعات سرور
versionstring?نسخه سرور (فقط برای دسته‌بندی mc)
colorstringرنگ مربوط به سرور
logostringURL لوگوی سرور
bannerstring?URL بنر سرور
splashBannerstring?URL بنر Splash سرور
motdstring?پیام روز (فقط برای دسته‌بندی mc و در صورت آنلاین بودن)
isOnlinebooleanوضعیت آنلاین بودن سرور
isVerifybooleanوضعیت تأیید شده بودن سرور
portnumberپورت سرور
pingnumberزمان پینگ سرور
maxPlayersnumber?حداکثر تعداد بازیکنان (فقط در صورت آنلاین بودن)
topPlayersnumberرکورد بیشترین بازیکن انلاین
playersnumberتعداد بازیکنان انلاین
ratingnumberامتیاز سرور بر اساس نظرات کاربران
boostsnumberتعداد بوست‌های فعال برای سرور
likesnumberتعداد لایک‌ها سرور
votesnumberتعداد رای‌ها سرور
socialobjectاطلاعات شبکه‌های اجتماعی مرتبط با سرور
tagsarray?برچسب‌های مربوط به سرور (فقط برای دسته‌بندی fivem)
gamemodesarray?لیست گیم‌مودهای سرور (فقط برای دسته‌بندی mc)
badgesarrayنشان‌های مربوط به سرور
achievementsarrayدستاوردهای مربوط به سرور

📱 اطلاعات شبکه‌های اجتماعی

این بخش شامل لینک‌های مربوط به شبکه‌های اجتماعی سرور است. با استفاده از این اطلاعات، می‌توانید به راحتی به کانال‌های ارتباطی و اطلاعات بیشتر درباره سرور دسترسی پیدا کنید.

کلیدنوعتوضیحات
discordstring?لینک سرور دیسکورد
telegramstring?لینک کانال تلگرام
instagramstring?لینک پروفایل اینستاگرام
websitestring?لینک وب‌سایت سرور
teamspeakstring?لینک سرور تیم اسپیک

🏷️ برچسب‌ها

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

کلیدنوعتوضیحات
itemstringهر برچسب به صورت یک رشته (string)

🎮 گیم‌مودها

این بخش شامل لیستی از گیم‌مودهای موجود در سرور است. هر گیم‌مود با نام و تعداد بازیکنان حاضر در آن مشخص می‌شود.

کلیدنوعتوضیحات
namestringنام گیم‌مود
playersnumberتعداد بازیکنان حاضر در آن گیم‌مود

🏅 نشان‌ها

این بخش شامل نشان‌های مربوط به سرور است. هر نشان شامل توضیحاتی درباره ویژگی‌ها و امتیازات مربوط به سرور می‌باشد.

کلیدنوعتوضیحات
itemstringتوضیحات نشان

🏆 دستاوردها

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

کلیدنوعتوضیحات
receivedAtstringتاریخ دریافت دستاورد
typestringنوع دستاورد (boost,vote,player,like)
levelnumberسطح دستاورد
آخرین آپدیت