حساب

دریافت اطلاعات حساب کاربری

GEThttps://api.parsget.com/api/v1/account
OAuth یا Personal API Key

مشخصات حساب، پلن فعال، موجودی اعتبار و سهمیه‌های دانلود را دریافت کنید. پاسخ مربوط به حسابی است که Access Token یا Personal API Key شما به آن تعلق دارد.

نام و تاریخ پایان پلن را از plan، اعتبار قابل مصرف را از credits.remaining و محدودیت‌ها و سهمیه‌های دانلود را از limits بخوانید. اگر حساب پلن فعال نداشته باشد، plan برابر null است.

صفر بودن اعتبار به‌تنهایی به معنی نداشتن امکان دانلود نیست؛ حساب رایگان ممکن است هنوز سهمیه روزانه داشته باشد. برای نمایش تعداد و حجم دانلود باقی‌مانده، از مقادیر limits استفاده کنید.

OAuth Scope: user:read

Response schema

200اطلاعات حساب کاربری
Payloadobject
id
string
—
name
string
—
email
stringemail
—
email_verified
boolean
—
created_at
stringdate-time
—
plan
object
نام و تاریخ پایان پلن فعال حساب. اگر حساب پلن فعال نداشته باشد، مقدار آن null است؛ حتی اگر اعتبار قابل مصرف داشته باشد. برای حساب‌های دارای اعتبار قدیمی، نام پلن Legacy credits است. اعتبار این حساب‌ها منقضی نمی‌شود؛ تاریخ 2030-01-01T00:00:00.000000Z را که در پاسخ می‌آید، به‌عنوان تاریخ انقضا نمایش ندهید.
name
string
—
expires_at
stringdate-time
تاریخ پایان پلن با فرمت ISO 8601 و به وقت UTC. این تاریخ، زمان انقضای اعتبار حساب نیست.
credits
object
remaining
number
موجودی اعتباری که اکنون می‌توانید مصرف کنید. اعتبار منقضی‌شده یا کنارگذاشته‌شده برای درخواست‌های دیگر در این مقدار حساب نمی‌شود. واحد این مقدار همان واحد اعتبار نمایش‌داده‌شده در حساب کاربر است؛ حساب‌های قدیمی واحد اعتبار خود را حفظ می‌کنند.
limits
object
محدودیت‌های دانلود و سهمیه‌های روزانه حساب. مقدار null یعنی آن محدودیت برای این حساب وجود ندارد. حساب رایگان ممکن است با وجود صفر بودن credits.remaining، هنوز سهمیه دانلود داشته باشد.
daily_downloads
object
تعداد دانلودهای مجاز در روز در limit و تعداد باقی‌مانده برای امروز در remaining می‌آید. مقدار null یعنی تعداد دانلودهای روزانه محدود نیست. دانلودهایی که با خطا متوقف، لغو یا حذف شده‌اند هم از سهمیه کم می‌شوند. سهمیه هر روز ساعت ۰۰:۰۰ به وقت تهران تجدید می‌شود؛ زمان نوبت بعد در resets_at و به وقت UTC می‌آید.
limit
integer
min 1
—
remaining
integer
min 0
—
resets_at
stringdate-time
—
daily_download_bytes
object
حجم مجاز دانلود روزانه در limit و حجم باقی‌مانده در remaining، هر دو بر حسب بایت می‌آیند. مقدار null یعنی حجم دانلود روزانه محدود نیست. حجم مصرف‌شده و حجم کنارگذاشته‌شده برای دانلودهای در حال انجام، از remaining کم شده‌اند. سهمیه هر روز ساعت ۰۰:۰۰ به وقت تهران تجدید می‌شود؛ زمان نوبت بعد در resets_at و به وقت UTC می‌آید.
limit
integer
min 1
—
remaining
integer
min 0
—
resets_at
stringdate-time
—
max_file_size_bytes
integer
min 1
حداکثر حجم مجاز هر فایل بر حسب بایت. مقدار null یعنی محدودیتی برای حجم هر فایل وجود ندارد.
concurrent_downloads
integer
min 1
حداکثر تعداد دانلودهایی که می‌توانند هم‌زمان فعال باشند؛ تورنت‌ها هم در این تعداد حساب می‌شوند. مقدار null یعنی محدودیتی برای تعداد کل دانلودهای هم‌زمان وجود ندارد.
concurrent_torrents
integer
min 1
حداکثر تعداد تورنت‌هایی که می‌توانند هم‌زمان فعال باشند. اگر concurrent_downloads هم محدودیت داشته باشد، مجموع تورنت‌ها و سایر دانلودهای فعال نباید از آن بیشتر شود. مقدار null یعنی تورنت محدودیت جداگانه‌ای ندارد.
پاسخ‌های خطاساختار استاندارد error