پرش به مطلب اصلی

کد وضعیت ها و خطاها

کدهای وضعیت HTTP​

کدتوضیحات
200عملیات با موفقیت انجام شد
401توکن وجود ندارد یا نامعتبر است
403خطای دسترسی
400درخواست نامعتبر
404دیتای مورد نظر یافت نشد
422مقادیر ورودی به درستی وارد نشده است
500خطای داخلی سرور لطفا این مورد را به پشتیبانی اطلاع دهید

کدهای پاسخ API​

تمامی پاسخ‌های API شامل فیلدهای زیر هستند:

{
    "code": 100,        // کد وضعیت داخلی
    "msg": "OK",        // پیام وضعیت
    "data": {}          // داده‌های پاسخ
}

کدهای موفقیت​

کدپیامتوضیحات
100OKدرخواست با موفقیت انجام شد

کدهای خطا​

کدپیامتوضیحات
400Bad Requestدرخواست نامعتبر
401Unauthorizedاحراز هویت ناموفق
403Forbiddenدسترسی مجاز نیست
404Not Foundمنبع یافت نشد
429Too Many Requestsتعداد درخواست‌ها بیش از حد مجاز
500Internal Server Errorخطای داخلی سرور

شرایط استفاده​

هشدار مهم
  • در نظر داشته باشید که تنها بخش‌هایی که در مستندات API اوکی اکسچنج ذکر شده باشند، API عمومی و قابل استفاده در اوکی اکسچنج محسوب می‌شوند
  • اگر endpoint یا هر فیلدی در مستندات ذکر نشده باشد، ممکن است بدون اطلاع قبلی دچار تغییر شود

نکات مهم​

  • این امکان وجود دارد که در طول زمان تغییراتی در API عمومی اوکی اکسچنج به وجود آید
  • تغییرات در بخش «سابقه تغییرات API اوکی اکسچنج» اطلاع‌رسانی خواهند شد
  • لازم است استفاده کنندگان به صورت منظم این بخش را رصد نمایند

محدودیت‌های امنیتی​

  • در صورتی که پاسخی مبنی بر استفاده نادرست از API مانند خطای 429 دریافت شود، استفاده کننده ملزم است که واکنش مناسبی نشان دهد
  • حملات DDOS یا هرگونه اعمال مخرب خلاف شرایط استفاده است
  • در صورت مشاهده، تمامی حساب‌های کاربری مرتبط مسدود خواهند شد

فرمت پاسخ‌ها​

  • به طور معمول خروجی API به صورت JSON ارائه می‌شود
  • ممکن است فیلدهای اضافی نیز در خروجی پاسخ وجود داشته باشد
  • پیشنهاد می‌شود که برنامه خود را به شکلی توسعه دهید که در صورت وجود فیلدهای اضافی، عملکرد آن دچار خطا نشود

سابقه تغییرات​

1401/02/10​

  • راه اندازی بخش مستندات
  • اضافه کردن وب سرویس به بخش تبادل سریع

1401/04/15​

  • اضافه کردن وب سرویس به بخش بازار حرفه ای

1401/10/07​

  • راه اندازی بخش API Key
  • امکان کار با بخش های مربوط به حساب کاربری

1402/06/11​

  • اضافه کردن وب سرویس های estimate و convert

1404/06/25​

  • اضافه کردن مستندات کامل بازار اسپات (حرفه‌ای)
  • اضافه کردن وب سرویس‌های لیست نمادهای معاملاتی و تیکر تمام نمادها
  • راه‌اندازی مستندات API عمومی بازار فیوچرز (تعهدی)
  • اضافه کردن وب سرویس‌های بررسی سلامت سیستم، تست اتصال و زمان سرور
  • بهبود مستندات احراز هویت و API Key

1405/07/13​

  • اصلاح فرمت نماد در نمونه‌های بازار اسپات به BTC-USDT
  • اضافه کردن پاسخ نمونه دفتر سفارشات اسپات
  • بازگرداندن خطای 400 برای نماد نامعتبر در دفتر سفارشات و معاملات اخیر اسپات

1405/07/20​

  • اضافه کردن جدول پارامترهای ثبت سفارش بازار فیوچرز (تعهدی)
  • اضافه کردن راهنمای باز کردن LONG/SHORT، بستن پوزیشن با reduceOnly و حد سود/حد ضرر (TP/SL)
  • اصلاح پاسخ نمونه ثبت سفارش و لیست نمادهای فیوچرز مطابق پاسخ واقعی سرویس
  • حذف پارامتر پشتیبانی‌نشده timeInForce از نمونه ثبت سفارش فیوچرز