خطاها و انواع داده
خطاها
| نوع پاسخ (Status Code) | توضیحات |
|---|---|
| 200 - OK | پاسخ موفقیت آمیز بودن یک درخواست |
| 400 - Bad Request | خطا در ارسال داده، معمولا به دلیل ارسال نشدن یک پارامتر به درستی |
| 401 - Unauthorized | کلیک API به درستی ارسال نشده است. |
| 429 - Too Many Requests | محدویت ارسال درخواست فعال شده است. |
| 403 - Forbidden | دسترسی شما به این API محدود شده است. |
| 500 - Internal Server Error | خطا در سرور، در این شرایط لطفا منتظر رفع آن بمانید. |
زمانی که خطای 400 رخ می دهد پاسخ API به شکل زیر برای شما ارسال می شود:
| توضیح | نوع داده | فیلد |
|---|---|---|
| رفرس خطای داده شده. در صورت بروز مشکل می توانید با در اختیار داشتن این کد جهت بررسی به پشتیبانی اطلاع دهید. | رشته | key |
| پیام خطا به صورت فارسی یا انگلیسی | رشته | message |
| نمایانگر بروز خطا | بولین | isSuccessful |
انواع داده
| مثال | توضیح | نوع داده |
|---|---|---|
| 12345.634521 | شامل اعداد صحیح و اعشاری تا 14 رقم اعشار | عدد (number) |
| "BTC" | حداکثر تا 256 کاراکتر | رشته (string) |
| OrderSide: BUY/SELL | شامل مجموعه ای از مقادیر از پیش تعریف شده | لیست (enum) |
| 2024-09-10T05:29:21Z | با قالب ISO-8601 | تاریخ و زمان (datetime) |
| true/false | شامل دو مقدار | بولین (boolean) |