این API لیست بازیکنان یک سرور خاص را برمی‌گرداند. با استفاده از این API می‌توانید اطلاعات بازیکنان موجود در سرور را دریافت کنید. این API به‌ویژه برای دسته‌بندی‌های Fivem و MTA مناسب است و می‌توانید با استفاده از پارامترهای مختلف، لیست بازیکنان را مدیریت کنید.
این endpoint لیست بازیکنان یک سرور خاص را برمی‌گرداند.
در صورت داشتن
?در کنار نوع داده، این مقدار میتواند خالی باشد.
| پارامتر | نوع داده | توضیحات |
|---|---|---|
category | string | دسته‌بندی سرور مورد نظر؛ مانند fivem برای FiveM و mta برای MTA. |
serverName | string | نام سرور مورد نظر که باید در category مشخص‌شده ثبت شده باشد. |
query | string? | جستجوی بازیکنان بر اساس نام، شناسه دیسکورد یا نام استیم. |
page | number? | شماره صفحه برای پشتیبانی از pagination. |
perPage | number? | تعداد بازیکنان در هر صفحه. |
query، page و perPage لیست بازیکنان را جستجو و مدیریت کنید.لیستی از بازیکنان سرور Fivem به صورت زیر برگردانده می‌شود:
در صورت داشتن
?در کنار نوع داده، این مقدار ممکن استnullباشد.
اگر کلیری دارای
.باشد، به معنای این است که آن کلید یک شیء است.
| کلید | نوع داده | توضیحات |
|---|---|---|
id | number | شناسه بازیکن در سرور |
name | string | نام بازیکن در فایوام |
ping | number | پینگ بازیکن |
joinedAt | string | تاریخ پیوستن بازیکن به سرور |
playTime | number? | کل زمانی که بازیکن در سرور آنلاین بوده است |
steam | object? | اطلاعات مربوط به حساب استیم بازیکن |
steam.name | string? | نام استیم بازیکن |
steam.hex | string? | شناسه استیم بازیکن |
steam.avatar | string? | لینک آواتار استیم بازیکن |
discord | object? | اطلاعات مربوط به حساب دیسکورد بازیکن |
discord.id | string? | شناسه دیسکورد بازیکن |
discord.name | string? | نام دیسکورد بازیکن |
discord.username | string? | نام کاربری دیسکورد بازیکن |
discord.avatar | string? | لینک آواتار دیسکورد بازیکن |
playTime ها بر اساس دقیقه هستند و باید آن را به زمانی که مد نظر دارید تبدیل کنید.
لیستی از بازیکنان سرور MTA به صورت زیر برگردانده می‌شود:
| کلید | نوع داده | توضیحات |
|---|---|---|
name | string | نام بازیکن |
joinedAt | string | تاریخ پیوستن بازیکن به سرور |