مستندات API نوبیتکس

NOBITEX

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

پیش از استفاده از API نوبیتکس اطمینان حاصل کنید که با قوانین نوبیتکس و همچنین قوانین و شرایط استفاده از API نوبیتکس آشنایی کامل دارید. همین طور با توجه به احتمال ایجاد تغییرات در بستر نوبیتکس یا ساختار و جزئیات APIها، همواره به اطلاعیه‌های کانال رسمی تلگرام نوبیتکس و کانال رسمی تلگرام API نوبیتکس دقت کنید. به علاوه به صورت مستمر صفحه سابقه تغییرات API نوبیتکس را رصد کنید تا از تمامی تغییرات API نوبیتکس مطلع باشید.

در استفاده از API همواره اطمینان حاصل کنید که کد شما قابلیت مواجهه با حالت‌های خطا و شرایط و تغییرات پیش‌بینی نشده را داشته باشد و عکس العمل مناسبی در این خصوص نشان دهد. با توجه به حساسیت‌های بازارهای مالی، لازم است که کدهای استفاده کننده از API به صورت اصولی و با ملاحظاتی مانند کنترل نرخ درخواست‌ها در شرایط مختلف، مدیریت حالت‌های خطا، پیش‌گیری از تشدید آبشاری خطاها، سازوکارهای حفاظت در عمق، وجود سامانه‌های مانیتورینگ و اعلان، وجود سازوکارهای مدیریت ریسک و ... توسعه داده شود.

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

احراز هویت و توکن

Authorization: Token yourTOKENhereHEX0000000000

برای استفاده از APIهای غیر عمومی نیاز به ارسال توکن وجود دارد. این توکن باید به عنوان HTTP Header درخواست به صورت زیر ارسال شود:

Authorization: Token yourTOKENhereHEX0000000000

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

برای دریافت توکن می‌توانید با مراجعه به پنل کاربری خود در نوبیتکس، از بخش پروفایل وارد صفحه تنظیمات شده و توکن خود را دریافت نمایید. در صورتی که گزینه «مرا به خاطر بسپار» را در هنگام ورود به نوبیتکس انتخاب کرده باشید، این توکن تا ۳۰ روز یا زمان لاگ‌اوت شما از نوبیتکس معتبر خواهد ماند.

در صورت تمایل به دریافت دوره‌ای و خودکار توکن، می‌توانید از API ورود - دریافت توکن استفاده نمایید. ولی این کار ضروری نیست و روش پیشنهادی ما برای اغلب کاربران دریافت مستقیم توکن از پنل کاربری است. تنها در صورتی که با مخاطرات ذخیره گذرواژه خود در کد و روش‌های امن این کار آشنا هستید، در استفاده از API مهارت دارید، و از طرفی نیاز به دریافت کاملاً خودکار توکن دارید، از API دریافت توکن استفاده نمایید.

تنظیم User Agent

جهت شناسایی و تفکیک بهتر بات‌ها و پشتیبانی از آن‌ها، اکیداً توصیه می‌شود که در تمامی درخواست‌ها مقدار UserAgent را مطابق الگوی TraderBot/XXXXX ارسال نمایید، که بخش XXXXX هر نام یکتایی است که می‌توانید برای بات خود انتخاب کنید. با رعایت این نام‌گذاری پاسخگویی به درخواست‌های پشتیبانی و عیب‌یابی مشکلات بهتر صورت می‌گیرد.

محدودیت‌ها

توجه داشته باشید، برای استفاده از APIها محدودیت هایی وجود دارد که در قسمت توضیحات هر کدام از APIها این موارد ذکر شده است.

همچنین به منظور حفظ امنیت حساب کاربران، در هنگام احرازهویت(لاگین)، در صورتی که دستگاه شما جدید شناخته شود، محدودیت برداشت به مدت یک‌ساعت روی حساب کاربری شما اعمال خواهد شد. کاربرانی که فرایند دریافت توکن با زمان کمتر از این یک‌ساعت دارند میتوانند مقدار device را که در جواب دریافت توکن دریافت کرده‌اند را در مراحل بعدی به همراه دیگر پارامترها ارسال، تا از اعمال این محدودیت جلوگیری نمایند.

روش دیگری که پیش و روی شماست استفاده از توکن‌های بلندمدت است.

تغییرات و موارد قدیمی

با توجه به ماهیت نوین و تغییرات مستمر مورد نیاز در حوزه رمزارزها، در API نوبیتکس نیز ممکن است در طول زمان تغییراتی ایجاد شود. پشتیبانی طولانی‌مدت از نسخه‌های قدیمی API معمولاً فرآیندی پیچیده و سخت است و باعث کاهش سرعت ایجاد تغییرات جدید در بستر نوبیتکس می‌شود. به همین دلیل API نوبیتکس همواره در عین حفظ ساختار کلی و اجزای اصلی ثابت، در حال بهبود مستمر و به‌روزرسانی است. کاربران گرامی می‌توانند با پیگیری تغییرات API که در صفحه سابقه تغییرات API نوبیتکس اطلاع‌رسانی می‌شود، همواره از تغییرات احتمالی ضروری در کد خود مطلع شوند تا بتوانند به صورت بدون وقفه از جدیدترین امکانات و روش‌های دسترسی به API نوبیتکس بهره‌مند شوند.

مواردی که قبلاً در API موجود بودند ولی در حال حاضر پشتیبانی نمی‌شوند، جهت ثبت سابقه در صفحه API قدیمی موجود هستند. ممکن است APIهای دیگری علاوه بر موارد مستند شده در مستندات پیش‌رو وجود داشته باشند، که این موارد جز API رسمی نوبیتکس نبوده و تضمینی در قبال ادامه‌دار بودن پشتیبانی از آن‌ها وجود ندارد. همین طور در استفاده از APIهای فعلی لازم به توضیح است که ممکن است علاوه بر فیلدهایی که در ورودی یا خروجی مستند شده است، فیلدهای دیگری نیز وجود داشته باشند. این فیلدها تا زمانی که در مستندات اضافه نشده باشند باید به عنوان امکانات آزمایشی و موقت در نظر گرفته شوند و نباید مورد استفاده عموم کاربران قرار گیرد. تنها کافی است که کدهای توسعه داده شده در صورت مشاهده فیلدی غیر از فیلدهای مورد انتظار خود، دچار خطا نشوند و صرفاً وجود آن فیلد را نادیده بگیرند.

راهنمای حل مشکلات

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

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

در صورتی که بخشی از مستندات API مبهم است، یا پیشنهادی درباره APIهای موجود دارید، یا پس از بررسی کامل اطمینان دارید که مشکلی در API نوبیتکس وجود دارد، می‌توانید در مخزن گیت‌هاب مستندات نوبیتکس API مورد (issue) جدیدی را ایجاد نمایید و با ما در ارتباط باشید. دقت کنید که این کانال عمومی است و نباید در آن هیچ گونه اطلاعات حساس یا توکن یا سایر اطلاعات حساب خود را مطرح کنید.

راهنمای شروع به کار با API

اگر برای اولین بار از API نوبیتکس یا سایر بازارهای رمزارز استفاده می‌کنید، برای شروع کار پیشنهاد می‌شود گام‌های زیر را طی کنید:

• برای شروع کار با API پیشنهاد می‌شود که ابتدا در نوبیتکس ثبت‌نام نمایید و مراحل احراز هویت خود را حداقل تا سطح یک انجام دهید.
• با مراجعه به پنل کاربری خود در نوبیتکس، از بخش پروفایل وارد صفحه تنظیمات شده و توکن خود را دریافت نمایید. دسترسی به این توکن به منزله دسترسی کامل به حساب شماست، در نتیجه در حفاظت آن دقت کامل داشته باشید.
• اگر با نرم‌افزار Postman آشنا هستید، می‌توانید برای تست فراخوانی APIهای اصلی نوبیتکس، از کالکشن Postman نوبیتکس استفاده کنید. لازم به توضیح است که این کالکشن تنها شامل برخی از APIهای نوبیتکس و کاربرد آن‌ها است و مرجع اصلی مستندات، همین صفحه است.

همین طور می‌توانید بنا به نیاز خود این موارد را نیز در ادامه در نظر بگیرید:

• در صورت تمایل به دریافت دوره‌ای و خودکار توکن، می‌توانید از API ورود - دریافت توکن استفاده نمایید.

اطلاعات بازار (عمومی)

لیست سفارش‌ها: اردربوک

curl 'https://api.nobitex.ir/v2/orderbook/BTCIRT'

http GET https://api.nobitex.ir/v2/orderbook/BTCIRT

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
    "status": "ok",
    "lastUpdate": 1644991756704,
    "bids": [
        ["1476091000", "1.016"],
        ["1479700000", "0.2561"]
    ],
    "asks": [
        ["1470001120", "0.126571"],
        ["1470000000", "0.818994"]
    ]
}

برای دریافت لیست سفارش‌ها یا همان اردربوک بازارهای مختلف، از این درخواست استفاده نمایید:

• درخواست: GET /v2/orderbook/SYMBOL
• محدودیت فراخوانی: 60 درخواست در دقیقه
• نیاز به ارسال توکن: ندارد

پارامترهای ورودی

نمونه پاسخ درخواست /v2/orderbook/all:

{
  "status": "ok",
  "BTCIRT": {
    "lastUpdate": 1644991756704,
    "bids": [
      ["1476091000", "1.016"],
      ["1479700000", "0.2561"]
    ],
    "asks": [
      ["1470001120", "0.126571"],
      ["1470000000", "0.818994"]
    ]
  },
  "USDTIRT": {
    "lastUpdate": 1644991767392,
    "bids": [
      ["277990", "6688.3"],
      ["278000", "28185.03"]
    ],
    "asks": [
      ["277960", "119.31"],
      ["277960", "1079.75"]
    ]
  }
}

پارامترهای پاسخ

خروجی شامل دو آرایه asks و bids بوده که در هر یک قیمت و مقدار سفارش‌های بازار وجود دارد. به دلایل تاریخی سفارش‌های فروش در bids و سفارش‌های خرید در asks بازگردانده می‌شوند. هر یک از این آرایه‌ها شامل دوتایی‌های «قیمت، مقدار» هستند.

همچنین زمان آخرین به‌روزرسانی در اردربوک ذیل پارامتر lastUpdate به فرمت یونیکس داده می‌شود.

روش پیشنهادی نگهداری اردربوک

در صورتی که در کد خود نیاز به نگهداری آخرین وضعیت اردربوک نوبیتکس هستید، در یک حلقه اقدام به دریافت اردربوک نوبیتکس نمایید. حتماً در میان هر دو بار اجرای حلقه حداقل یک تا ده ثانیه صبر نمایید و از فراخوانی پیاپی و بی‌مکث اردربوک خودداری کنید. به دلیل وجود لایه‌های کش، در صورت فراخوانی در بازه‌های زیر یک ثانیه، همان داده فراخوانی قبلی را دریافت خواهید نمود. اگر در اغلب بازارهای نوبیتکس فعال هستید، می‌توانید در هر فراخوانی کل اردربوک را دریافت نمایید تا نیازی به فراخوانی همزمان چند اردربوک نداشته باشید. اگر کد خود را در چند رشته (ترد) یا پردازه یا سرور اجرا می‌کنید، حتماً اردربوک را در یک مرجع واحد دریافت نمایید و آن را در میان نمونه‌های برنامه خود به اشتراک بگذارید.

نمودار عمق (آزمایشی)

curl 'https://api.nobitex.ir/v2/depth/BTCIRT'

http GET https://api.nobitex.ir/v2/depth/BTCIRT

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
  "status": "ok",
  "lastUpdate": "1658565992195",
  "bids": [["7309999000", "2.200274"], ["7310000000", "2.199856"], ["7310025000", "2.102569"]],
  "asks": [["7409894000", "0.054789"], ["7447665000", "0.055276"], ["7450000000", "0.059756"]],
  "lastTradePrice": "7417000000"}

برای دریافت داده‌های نمودار عمق، یا همان اردربوک بازارهای مختلف، از این درخواست استفاده نمایید:

• درخواست: GET /v2/depth/SYMBOL
• محدودیت فراخوانی: 60 درخواست در دقیقه
• نیاز به ارسال توکن: ندارد

پارامترهای ورودی

پارامترهای پاسخ

خروجی شامل دو آرایه asks و bids بوده که در هر یک قیمت و مقدار سفارش‌های بازار وجود دارد. سفارش‌های خرید در bids و سفارش‌های فروش در asks بازگردانده می‌شوند. هر یک از این آرایه‌ها شامل دوتایی‌های «قیمت، مقدار» هستند که در هر دوتایی، مقدار قیمت، تجمیع شده و گرد شده با دقت مناسب بازار مورد نظر است.

همچنین زمان آخرین به‌روزرسانی نمودار عمق ذیل پارامتر lastUpdate به فرمت یونیکس داده می‌شود.

همچنین، مبلغ آخرین معامله ذیل پارامتر lastTradePrice ارسال می‌شود.

روش پیشنهادی نگهداری نمودار عمق

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

لیست معاملات

curl 'https://api.nobitex.ir/v2/trades/BCHIRT'

http GET https://api.nobitex.ir/v2/trades/BCHIRT

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
    "status": "ok",
    "trades": [
        {
            "time": 1588689375067,
            "price": "1470000110",
            "volume": "0",
            "type": "sell"
        },
        {
            "time": 1588689360464,
            "price": "1470000110",
            "volume": "0.002",
            "type": "buy"
        }
    ]
}

برای دریافت لیست معاملات از این نوع درخواست استفاده نمایید:

• درخواست: GET v2/trades/SYMBOL
• محدودیت فراخوانی: 15 درخواست در دقیقه
• نیاز به ارسال توکن: ندارد

پارامترهای ورودی

پارامتر بازگشتی time زمان دقیق انجام شدن معامله است که با فرمت یونیکس نمایش داده میشود

آمار بازار نوبیتکس

curl 'https://api.nobitex.ir/market/stats?srcCurrency=btc&dstCurrency=rls'

http GET https://api.nobitex.ir/market/stats \
  srcCurrency=btc dstCurrency=rls

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
  "status": "ok",
  "stats": {
    "btc-rls": {
      "isClosed": false,
      "bestSell": "749976360",
      "bestBuy": "733059600",
      "volumeSrc": "0.2929480000",
      "volumeDst": "212724856.0678640000",
      "latest": "750350000",
      "mark": "747461987",
      "dayLow": "686021860",
      "dayHigh": "750350000",
      "dayOpen": "686021860",
      "dayClose": "750350000",
      "dayChange": "9.38"
    }
  }
}

برای دریافت آخرین آمار بازار نوبیتکس از این نوع درخواست استفاده نمایید:

• درخواست GET /market/stats
• محدودیت فراخوانی: ۱۰۰ درخواست در دقیقه

پارامترهای ورودی

آمار OHLC بازار نوبیتکس

curl 'https://api.nobitex.ir/market/udf/history?symbol=BTCIRT&resolution=D&from=1562058167&to=1562230967'

http GET https://api.nobitex.ir/market/udf/history?symbol=BTCIRT&resolution=D&from=1562058167&to=1562230967

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
  "s": "ok",
  "t": [1562095800, 1562182200],
  "o": [146272500, 150551000],
  "h": [155869600, 161869500],
  "l": [140062400, 150551000],
  "c": [151440200, 157000000],
  "v": [18.221362316, 9.8592626506]
}

برای توضیحات بیشتر در مورد OHLC به این لینک مراجعه کنید.

برای دریافت آمار OHLC نوبیتکس از این نوع درخواست استفاده نمایید:

• درخواست: GET /market/udf/history

پارامترهای ورودی

در صورت ورودی اشتباه برای resolution پاسخ به این صورت خواهد بود:

{
  "s": "error",
  "errmsg": "Invalid resolution!"
}

• پارامتر resolution بازه زمانی کندل‌های خروجی می‌باشد و مقدار آن می‌تواند یکی از مقادیر زیر باشد:

• مقادیر from و to زمان شروع و پایان جست‌وجو را مشخص می‌کند و با فرمت یونیکس به ثانیه مشخص می‌شود.

در صورت نبودن داده در بازه درخواستی پاسخ به این صورت خواهد بود:

{
  "s": "no_data"
}

پارامترهای پاسخ

در هر درخواست بسته به پارامتر countback یا بازه زمانی تعیین شده و resolution انتخابی، تعداد کندل‌های برگشتی متفاوت است. برای مثال تعداد کندل‌های 1 ساعته از تاریخ 2019/2/9 15:39:41 تا چهار ساعت قبل آن، ۴ تاست.

• در هر درخواست حداکثر 500 کندل بازگردانده می‌شود. برای بازیابی همه کندل‌های یک بازه با بیش از 500 کندل، از پارامتر page برای صفحه‌بندی استفاده نمایید.

آمار بازار جهانی

curl 'https://api.nobitex.ir/market/global-stats' \
  -X POST

http POST https://api.nobitex.ir/market/global-stats

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
    "ltc": {
        "kraken": {
            "price": "41.69"
        }
    },
    "btc": {
        "kraken": {
            "price": "5517.2"
        }
    },
    ...

    "status": "ok"
}

برای دریافت آمار بازارهای جهانی از این نوع درخواست استفاده نمایید:

• درخواست: POST /market/global-stats
• محدودیت فراخوانی: ۱۰۰ درخواست در ۱۰ دقیقه

اطلاعات کاربر

پروفایل

curl 'https://api.nobitex.ir/users/profile' \
  -H "Authorization: Token yourTOKENhereHEX0000000000"

http POST https://api.nobitex.ir/users/profile \

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
  "status": "ok",
  "profile": {
    "firstName": "مهدی",
    "lastName": "رضایی",
    "nationalCode": "011122333",
    "email": "name@example.com",
    "username": "name@example.com",
    "phone": "02142719000-9012",
    "mobile": "09151111111",
    "city": "مشهد",
    "bankCards": [
      {
        "number": "6037-9900-0000-0000",
        "bank": "ملی",
        "owner": "مهدی رضایی",
        "confirmed": true,
        "status": "confirmed"
      }
    ],
    "bankAccounts": [
      {
        "id": 1999,
        "number": "0346666666666",
        "shaba": "IR460170000000346666666666",
        "bank": "ملی",
        "owner": "مهدی رضایی",
        "confirmed": true,
        "status": "confirmed"
      }
    ],
    "verifications": {
      "email": true,
      "phone": true,
      "mobile": true,
      "identity": true,
      "selfie": false,
      "bankAccount": true,
      "bankCard": true,
      "address": true,
      "city": true,
      "nationalSerialNumber": true
    },
    "pendingVerifications": {
      "email": false,
      "phone": false,
      "mobile": false,
      "identity": false,
      "selfie": false,
      "bankAccount": false,
      "bankCard": false
    },
    "options": {
      "fee": "0.35",
      "feeUsdt": "0.2",
      "isManualFee": false,
      "tfa": false,
      "socialLoginEnabled": false
    },
    "withdrawEligible": true
  },
  "tradeStats": {
    "monthTradesTotal": "10867181.5365000000",
    "monthTradesCount": 3
  }
}

این api، اطلاعات پروفایل شما، کارت بانکی، حساب بانکی، موارد تایید شده(ایمیل، شماره تلفن، موبایل ...)، تنظمیات مربوط به پروفایل(فی تراکنش، فی مبادلات usdt و ...) و خلاصه آمار مبادلات شما را برمیگرداند.

برای دریافت پروفایل کاربر از این نوع درخواست استفاده نمایید:

• درخواست: GET /users/profile

پارامترهای ورودی

برای دریافت پاسخ، کافیست توکن احراز هویت را ارسال نمایید

تولید آدرس بلاکچین

curl 'https://api.nobitex.ir/users/wallets/generate-address' \
  -X POST \
  -H "Authorization: Token yourTOKENhereHEX0000000000" \
  -H "content-type: application/json" \
  --data '{"currency":"btc"}'

http POST https://api.nobitex.ir/users/wallets/generate-address \
  currency=btc

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
    "status": "ok",
    "address": "LRf3vuTMy4UwD5b72G84hmkfGBQYJeTwUs"
}

برای تولید آدرس بلاکچین از این نوع درخواست استفاده نمایید:

• درخواست: POST /users/wallets/generate-address
• محدودیت فراخوانی: ۳۰ درخواست در ساعت

پارامترهای ورودی

افزودن کارت بانکی

curl 'https://api.nobitex.ir/users/cards-add' \
  -X POST \
  -H "Authorization: Token yourTOKENhereHEX0000000000" \
  -H "content-type: application/json" \
  --data '{"number":"5041721011111111","bank":"رسالت"}'

http POST https://api.nobitex.ir/users/cards-add \
  number=5041721011111111 bank=رسالت

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
    "status": "ok"
}

برای افزودن کارت بانکی جدید از این نوع درخواست استفاده نمایید:

• درخواست: POST /users/cards-add
• محدودیت فراخوانی: ۳۰ درخواست در هر ۳۰ دقیقه

پارامترهای ورودی

افزودن حساب بانکی

curl 'https://api.nobitex.ir/users/accounts-add' \
  -X POST \
  -H "Authorization: Token yourTOKENhereHEX0000000000" \
  -H "content-type: application/json" \
  --data '{"number":"5041721011111111","shaba":"IR111111111111111111111111","bank":"رسالت"}'

http POST https://api.nobitex.ir/users/accounts-add \
  number=5041721011111111 shaba=IR111111111111111111111111 bank=رسالت

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
    "status": "ok"
}

برای افزودن حساب بانکی جدید از این نوع درخواست استفاده نمایید:

• درخواست: POST /users/accounts-add
• محدودیت فراخوانی: ۳۰ درخواست در ۳۰ دقیقه

پارامترهای ورودی

محدودیت های کاربر

curl 'https://api.nobitex.ir/users/limitations' \
  -X GET \
  -H "Authorization: Token yourTOKENhereHEX0000000000" \
  -H "content-type: application/json" \

http GET https://api.nobitex.ir/users/limitations

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
  "status": "ok",
  "limitations": {
    "userLevel": "level2",
    "features": {
      "crypto_trade": false,
      "rial_trade": false,
      "coin_deposit": false,
      "rial_deposit": false,
      "coin_withdrawal": false,
      "rial_withdrawal": false
    },
    "limits": {
      "withdrawRialDaily": {
        "used": "0",
        "limit": "900000000"
      },
      "withdrawCoinDaily": {
        "used": "0",
        "limit": "2000000000"
      },
      "withdrawTotalDaily": {
        "used": "0",
        "limit": "2000000000"
      },
      "withdrawTotalMonthly": {
        "used": "0",
        "limit": "30000000000"
      }
    }
  }
}

توضیحات

کاربران در نوبیتکس بر اساس سطح کاربری خود، محدودیت هایی در برداشت، واریز و مبادلات خود دارند. هر کاربر نسبت به نیاز خود و میزان مبادلاتی که دارد میتواند با ارائه مدارک مورد نیاز ، سطح کاربری خود را پس از احراز هویت و تایید مدراک، ارتقا دهد. اطلاعات نمایش داده شده در خروجی api شامل همین محدودیت ها میباشد:

برای دریافت محدودیت های کاربر از این نوع درخواست استفاده نمایید:

• درخواست: POST /users/limitations

پارامترهای ورودی

• در این بخش به ورودی نیاز نیست.
• توکن دریافتی از بخش لاگین باید در هدر ارسال شود.

پارامترهای خروجی

features: شرایط حساب کاربری

• crypto_trade: امکان مبادله رمز ارزها
• rial_trade: امکان مبادله با ریال
• coin_deposit: امکان واریز رمز ارز به کیف پول نوبیتکس
• rial_deposit: امکان واریز ریال به کیف پول نوبیتکس
• coin_withdrawal: امکان برداشت رمز ارز از کیف پول نوبیتکس به کیف پول دیگر
• rial_withdrawal: امکان برداشت ریال از کیف پول نوبیتکس به حساب بانکی

limits: محدودیت های حساب کاربری

• withdrawRialDaily: مقدار مجاز برای برداشت روزانه ریال
• withdrawRialDaily: مقدار مجاز برای برداشت روزانه رمز ارز
• withdrawTotalDaily: مقدار مجاز برای برداشت روزانه مجموع رمز ارز و ریال
• withdrawTotalMonthly: مقدار مجاز برای برداشت ماهیانه مجموع رمز ارز و ریال

نکات و ملاحظات

1. تمامی مبالغ در خروجی به ریال هستند.
2. برای اطلاع از جزئیات سطوح کاربری، میزان محدودیت ها، مدارک مورد نیاز هر سطح و توضیحات کامل هر سطح به سطوح حساب کاربری در نوبیتکس مراجعه کنید. #اطلاعات مالی کاربر

لیست کیف پول ها

curl 'https://api.nobitex.ir/users/wallets/list' \
  --header "Authorization: Token yourTOKENhereHEX0000000000"

http GET https://api.nobitex.ir/users/wallets/list \
  Authorization=Token yourTOKENhereHEX0000000000

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
  "status": "ok",
  "wallets": [
    {
      "depositAddress": null,
      "depositTag": null,
      "depositInfo": {
        "FIAT_MONEY": {
          "address": null,
          "tag": null
        }
      },
      "id": 2693280,
      "currency": "rls",
      "balance": "746212980",
      "blockedBalance": "0",
      "activeBalance": "746212980",
      "rialBalance": 746212980,
      "rialBalanceSell": 746212980
    },
    {
      "depositAddress": "bc1qp8dvtrhgjae6qhjfmvs2dj80ck0hgdjs6ts720",
      "depositTag": null,
      "depositInfo": {
        "BTC-LEGACY": {
          "address": null,
          "tag": null
        },
        "BTC": {
          "address": "bc1qp8dvtrhgjae6qhjfmvs2dj80ck0hgdjs6ts720",
          "tag": null
        },
        "BTCLN": {
          "address": null,
          "tag": null
        },
        "BSC": {
          "address": null,
          "tag": null
        }
      },
      "id": 133778,
      "currency": "btc",
      "balance": "0",
      "blockedBalance": "0",
      "activeBalance": "0",
      "rialBalance": 0,
      "rialBalanceSell": 0
    }
  ]
}

برای دریافت لیست کیف پول های کاربر از این نوع درخواست استفاده نمایید:

• درخواست: GET /users/wallets/list
• محدودیت فراخوانی: 20 درخواست در 2 دقیقه

نکات و ملاحظات

1. کیف پول یک رمزارز در صورتی برای کاربر ایجاد می‌شود که کاربر سفارشی در بازار آن رمزارز ثبت کرده و یا آدرس واریز برای آن ایجاد کرده باشد. این ویژگی در رمزارزهای آتی نوبیتکس نمایش خواهد یافت. برای رمزارزهای قدیمی کاربران سابق، همه کیف‌پول‌های از پیش موجود کاربر باقی خواهند ماند.
2. در برخی از موارد به دلیل کنترل بار ترافیک ورودی این سرویس، ممکن است پاسخ مورد انتظار دریافت نگردد، در این حالت می بایست مجددا فراخوانی را انجام داد و یا اینکه از این سرویس برای دریافت لیست کیف پول ها استفاده نمائید
3. برای مشخص کردن نوع کیف پول (spot or margin) میتوانید نوع آن را با استفاده از پارامتر type مشخص نمایید. به صورت پیش فرض کیف پول‌های spot لیست خواهند شد

لیست کیف پول ها (انتخابی)

curl 'https://api.nobitex.ir/v2/wallets?currencies=rls,btc' \
  --header "Authorization: Token yourTOKENhereHEX0000000000"

http GET https://api.nobitex.ir/v2/wallets \
  Authorization=Token yourTOKENhereHEX0000000000
  currencies=rls,btc

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
    "status": "ok",
    "wallets": {
        "RLS": {
            "id": 133777,
            "balance": "0E-10",
            "blocked": "0"
        },
        "BTC": {
            "id": 133778,
            "balance": "0E-10",
            "blocked": "0"
        }
    }
}

برای دریافت لیست کیف پول های کاربر از این نوع درخواست استفاده نمایید:

• درخواست: GET /v2/wallets
• محدودیت فراخوانی: 12 درخواست در دقیقه

پارامترهای ورودی

نکات و ملاحظات

کیف پول یک رمزارز در صورتی برای کاربر ایجاد می‌شود که کاربر سفارشی در بازار آن رمزارز ثبت کرده و یا آدرس واریز برای آن ایجاد کرده باشد. این ویژگی در رمزارزهای آتی نوبیتکس نمایش خواهد یافت. برای رمزارزهای قدیمی کاربران سابق، همه کیف‌پول‌های از پیش موجود کاربر باقی خواهند ماند.

موجودی

curl 'https://api.nobitex.ir/users/wallets/balance' \
  -X POST \
  --header "Authorization: Token yourTOKENhereHEX0000000000" \
  --data '{"currency":"ltc"}'

http POST https://api.nobitex.ir/users/wallets/balance \
  currency=ltc

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
    "balance": "10.2649975000",
    "status": "ok"
}

برای دریافت موجودی کیف پول های خود در نوبیتکس (شامل کیف پول ریالی و کیف پول های رمز ارزی) از این نوع درخواست استفاده نمایید:

• درخواست: POST /users/wallets/balance
• محدودیت فراخوانی: ۶۰ درخواست در ۲ دقیقه

پارامترهای ورودی

نکات و ملاحظات

1. مقدار بازگشتی برای موجودی، یک عدد است که به صورت string برگردانده میشود. این مقدار می‌تواند اعداد اعشاری زیادی داشته باشد.
2. اگر قصد محاسبات مهمی بر روی این اعداد را دارید، پیشنهاد ما این است که از انواع fixed precision برای نگهداری این اعداد استفاده کنید.

لیست تراکنش‌ها

curl 'https://api.nobitex.ir/users/wallets/transactions/list?wallet=4159' \
  -H "Authorization: Token yourTOKENhereHEX0000000000"

http GET https://api.nobitex.ir/users/wallets/transactions/list \
  wallet=4159

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
    "status": "ok",
    "transactions": [
        {
            "currency": "ltc",
            "created_at": "2018-10-17T09:41:08.519151+00:00",
            "calculatedFee": "0",
            "id": 99050,
            "amount": "4.3802000000",
            "description": "خرید 4.400 LTC به قیمت واحد ﷼7450000"
        },
        {
            "currency": "ltc",
            "created_at": "2018-10-04T13:05:01.384902+00:00",
            "calculatedFee": "0",
            "id": 96541,
            "amount": "-1.0000000000",
            "description": "Withdraw to \"Lgn1zc77mEjk72KvXPqyXq8K1mAfcDE6YR\""
        },
        ...
    ],
    "hasNext": true
}

برای دریافت آخرین آمار بازار نوبیتکس از این نوع درخواست استفاده نمایید:

• درخواست: GET /users/wallets/transactions/list
• محدودیت فراخوانی: ۶۰ درخواست در ۲ دقیقه
• صفحه بندی: دارد (پیشفرض ۵۰)

پارامترهای ورودی

لیست واریزها

curl 'https://api.nobitex.ir/users/wallets/deposits/list?wallet=4159' \
  -H "Authorization: Token yourTOKENhereHEX0000000000"

http GET https://api.nobitex.ir/users/wallets/deposits/list \
  wallet=4159

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
    "status": "ok",
    "deposits": [
        {
            "txHash": "c5d84268a0bf02307b5a0460a68b61987a9b3009d3a82a817e41558e619ec1d2",
            "address": "32KfyTNh162UoKithfDrWHZPYq5uePGmf7",
            "confirmed": true,
            "transaction": {
                "id": 10,
                "amount": "3.0000000000",
                "currency": "btc",
                "description": "Deposit - address:36n452uGq1x4mK7bfyZR8wgE47AnBb2pzi, tx:c5d84268a0bf02307b5a0460a68b61987a9b3009d3a82a817e41558e619ec1d2",
                "created_at": "2018-11-06T03:56:18+00:00",
                "calculatedFee": "0"
            },
            "currency": "Bitcoin",
            "blockchainUrl": "https://btc.com/c5d84268a0bf02307b5a0460a68b61987a9b3009d3a82a817e41558e619ec1d2",
            "confirmations": 2,
            "requiredConfirmations": 3,
            "amount": "3.0000000000"
        }
    ],
    "hasNext": true
}

برای دریافت لیست واریزها از این نوع درخواست استفاده نمایید:

• درخواست: GET /users/wallets/deposits/list
• محدودیت فراخوانی: ۶۰ درخواست در ۲ دقیقه
• صفحه بندی: دارد (پیشفرض ۱۰برای ریال و ۲۰برای سایر)
• فیلترزمانی: دارد

پارامترهای ورودی

نکات و ملاحظات

• از این طریق واریزهای حداکثر سه ماهه اخیر قابل نمایش است.
• صفحه بندی و فیلترزمانی فقط برای حالتی است که wallet تعیین شده باشد و برای حالت پیشفرض یعنی all کارایی ندارد.

بازارهای مورد علاقه

با استفاده از این امکان، کاربران قادر خواهند بود بازارهای مورد علاقه خود را مشخص کنند.

دریافت لیست بازارهای مورد علاقه

curl 'https://api.nobitex.ir/users/markets/favorite' \
  -X GET

http GET https://api.nobitex.ir/users/markets/favorite

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
    "status": "ok",
    "favoriteMarkets": [
        "XLMIRT",
        "BTCUSDT",
        "BTCIRT"
    ]
}

• درخواست: GET /users/markets/favorite
• محدودیت فراخوانی: 6 درخواست در ۱ دقیقه
• نیاز به ارسال توکن: دارد

ثبت بازار(های) مورد علاقه

curl 'https://api.nobitex.ir/users/markets/favorite' \
  -X POST

http POST https://api.nobitex.ir/users/markets/favorite

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
    "status": "ok",
    "favoriteMarkets": [
        "BTCIRT",
        "DOGEUSDT"
    ]
}

• درخواست: POST /users/markets/favorite
• محدودیت فراخوانی: 12 درخواست در ۱ دقیقه
• نیاز به ارسال توکن: دارد

پارامتر ورودی

حذف بازار مورد علاقه

curl 'https://api.nobitex.ir/users/markets/favorite' \
  -X DELETE

http DELETE https://api.nobitex.ir/users/markets/favorite

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
    "status": "ok",
    "favoriteMarkets": [
        "BTCIRT",
        "DOGEUSDT"
    ]
}

• درخواست: DELETE /users/markets/favorite
• محدودیت فراخوانی: 12 درخواست در ۱ دقیقه
• نیاز به ارسال توکن: دارد

پارامتر ورودی

معامله در بازار اسپات

ثبت سفارش جدید

curl 'https://api.nobitex.ir/market/orders/add' \
  -X POST \
  -H "Authorization: Token yourTOKENhereHEX0000000000" \
  -H "content-type: application/json" \
  --data '{"type":"buy","srcCurrency":"btc","dstCurrency":"rls","amount":"0.6","price":520000000,"clientOrderId":"order1"}'

http POST https://api.nobitex.ir/market/orders/add \
  type=buy srcCurrency=btc dstCurrency=rls amount=0.6 price=520000000 clientOrderId=order1

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
  "status": "ok",
  "order": {
    "type": "sell",
    "srcCurrency": "Bitcoin",
    "dstCurrency": "ریال",
    "price": "520000000",
    "amount": "0.6",
    "totalPrice": "312000000.0",
    "matchedAmount": 0,
    "unmatchedAmount": "0.6",
    "id": 25,
    "status": "Active",
    "partial": false,
    "fee": 0,
    "created_at": "2018-11-28T11:36:13.592827+00:00",
    "clientOrderId": "order1",
  }
}

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

• درخواست:: POST /market/orders/add
• محدودیت فراخوانی: ۲۰۰ درخواست در هر ۱۰ دقیقه

ثبت سفارش الزاماً به معنی انجام معامله نیست و بسته به نوع و قیمت سفارش و وضعیت لحظه‌ای بازار ممکن است معامله انجام شود یا نشود. با درخواست «مشاهده وضعیت سفارش» می‌توانید از وضعیت سفارش خود مطلع شوید.

سفارش‌ها پس از ثبت، پیش از ورود به دفتر معاملاتی و انجام معامله، مجدداً از نظر اعتبار مورد بررسی قرار گرفته و در صورت نامعتبر بودن، به وضعیت «رد شده» برده خواهند شد. به همین علت در صورتی که سفارش‌های شما ثبت می‌شود ولی بلافاصله به وضعیت «رد شده» تغییر حالت پیدا می‌کنند، پارامترهای ارسالی خود به ویژه مقدار و قیمت سفارش و موجودی حساب خود را دقیق‌تر بررسی نمایید.

پارامترهای ورودی

نمونه سفارش حد ضرر:

curl 'https://api.nobitex.ir/market/orders/add' \
  -X POST \
  -H "Authorization: Token yourTOKENhereHEX0000000000" \
  -H "content-type: application/json" \
  --data '{"type":"sell","srcCurrency":"doge","dstCurrency":"rls","amount":"64","execution":"stop_market","stopPrice":47500,"clientOrderId":"order1"}'

http POST https://api.nobitex.ir/market/orders/add \
  type=sell srcCurrency=doge dstCurrency=rls amount=64 execution=stop_market stopPrice=47500 clientOrderId=order1

{
  "status": "ok",
  "order": {
    "id": 26,
    "type": "sell",
    "execution": "StopMarket",
    "market": "DOGE-RLS",
    "srcCurrency": "Dogecoin",
    "dstCurrency": "\ufdfc",
    "price": "market",
    "amount": "64",
    "param1": "47500",
    "totalPrice": "0",
    "totalOrderPrice": "3008000",
    "matchedAmount": "0",
    "unmatchedAmount": "64",
    "status": "Inactive",
    "partial": false,
    "fee": 0,
    "created_at": "2022-01-17T12:14:18.005896+00:00",
    "averagePrice": "0",
    "clientOrderId": "order1",
  }
}

سفارش حد ضرر

این سفارش در زمان رسیدن قیمت بازار به قیمت توقف فعال خواهد شد. کاربرد اصلی آن، جلوگیری از زیان در صورت تغییر غیرمنتظره قیمت بازار است. با ثبت این نوع سفارش می‌توان بدون نیاز به رصد مداوم بازار، در صورت خروج قیمت از بازه مد نظر، اقدام به تبدیل دارایی نمود.

پارامترهای ویژه حد ضرر

نمونه سفارش OCO:

curl 'https://api.nobitex.ir/market/orders/add' \
  -X POST \
  -H "Authorization: Token yourTOKENhereHEX0000000000" \
  -H "content-type: application/json" \
  --data '{"type":"buy","srcCurrency":"btc","dstCurrency":"usdt","amount":"0.01","mode":"oco","price":42390,"stopPrice":42700,"stopLimitPrice":42715,"clientOrderId":"order1"}'

http POST https://api.nobitex.ir/market/orders/add \
  type=buy srcCurrency=btc dstCurrency=usdt amount=0.01 mode=oco price=42390 stopPrice=42700 stopLimitPrice=42715 clientOrderId=order1

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
  "status": "ok",
  "orders": [
    {
      "id": 27,
      "type": "buy",
      "execution": "Limit",
      "market": "BTC-USDT",
      "srcCurrency": "Bitcoin",
      "dstCurrency": "Tether",
      "price": "42390",
      "amount": "0.01",
      "totalPrice": "0",
      "totalOrderPrice": "423.9",
      "matchedAmount": "0",
      "unmatchedAmount": "0.01",
      "status": "Active",
      "created_at": "2022-04-10T10:12:38.402795+00:00",
      "pairId": 28,
      "clientOrderId": "order1"
    },
    {
      "id": 28,
      "type": "buy",
      "execution": "StopLimit",
      "market": "BTC-USDT",
      "srcCurrency": "Bitcoin",
      "dstCurrency": "Tether",
      "price": "42715",
      "amount": "0.01",
      "param1": "42700",
      "totalPrice": "0",
      "totalOrderPrice": "427.15",
      "matchedAmount": "0",
      "unmatchedAmount": "0.01",
      "status": "Inactive",
      "created_at": "2022-04-10T10:12:38.402795+00:00",
      "pairId": 27,
      "clientOrderId": null
    }
  ]
}

سفارش OCO

یک سفارش OCO در واقع متشکل از دو سفارش است: یک سفارش با قیمت معین، و یک سفارش با حد ضرر معین.

در صورتی که هر کدام از این دو سفارش انجام شوند، سفارش دیگر لغو خواهد شد. به عنوان مثال، اگر قیمت بازار، به قیمت سفارش معین برسد، سفارش معین اجرا می‌شود و سفارش حد ضرر، به طور خودکار لغو می‌گردد. عکس این حالت نیز برقرار است. اگر قیمت به حد ضرر تعیین شده برسد، سفارش حد ضرر اجرا شده، سفارش با قیمت معین لغو می‌گردد.

پارامترهای ویژه OCO

حالت‌های خطا

در صورت عدم پذیرش سفارش، پاسخ به این صورت خواهد بود:

{
  "status": "failed",
  "code": "ErrorCode",
  "message": "Human readable error message"
}

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

نکات و ملاحظات

1. واحدها: واحد قیمت در بازارهای ریالی به ریال (و نه تومان) می‌باشد. واحد قیمت در بازارهای تتری نیز تتر می‌باشد. واحد پارامتر مقدار (amount) بر حسب رمزارز مبدا (srcCurrency) است.
2. سفارش مارکت: برای ثبت سفارش سریع (سفارش مارکت، سفارش به قیمت بازار)، مقدار پارامتر execution را برابر market ارسال نمایید. منظور از سفارش مارکت سفارشی است که کاربر درخواست دارد تا به بهترین قیمت موجود بازار مورد انجام قرار گیرد. ℹB - ℹI
3. تعیین محدوده مورد انتظار قیمت: در سفارش‌های مارکت به شدت توصیه می‌شود که پارامتر price را نیز مشخص نمایید. این پارامتر در سفارش مارکت تخمین شما از قیمت بازار را نمایش می‌دهد و باعث می‌شود سفارش شما تنها تا جایی پر شود که قیمت معامله در بازه‌ی قیمتی مشخص شده باشد. برای نمونه اگر نوع سفارش خرید مارکت باشد و قیمت ۱۰۰ میلیون تومان تعیین شود، تنها تا جایی در بازار range کشیده می‌شود که قیمت زیر ۱۰۱ میلیون تومان باشد. برای پیش‌گیری از معاملات با قیمت ناخواسته به علت نوسانات دفعی بازار، پیشنهاد می‌شود که حتماً قیمت تقریبی مد نظر خود را در سفارش‌های مارکت نیز ارسال کنید. با این حال اگر اطمینان به کد خود و تبعات احتمالی این موضوع دارید، می‌توانید پارامتر price را اصلاً ارسال ننمایید که در این شرایط معامله با قیمت لحظه‌ای بازار جهانی، به هر میزان که باشد تا بازه نوسان ۱٪، انجام خواهد شد.
4. دقت مقادیر پولی (monetary): نوع monetary که در پارامترهای amount و price به کار می‌رود، بسته به بازار هر رمزارز، تعداد رقم اعشار متغیری بین ۰ تا ۸ رقم دارد. در صورت ارسال مقادیر با ارقام اعشاری بیشتر، ارقام بی‌معنی در مقدار به پایین و در قیمت به روش بانکداری گرد خواهند شد.
   مشاهده جدول دقت‌ها
5. clientOrderId: دقت کنید که این پارامتر برای هر کاربر در میان سفارش های open/active/inactive یکتاست.
6. سفارش تکراری: برای جلوگیری از ثبت سفارش تکراری ناشی از اختلالات شبکه و سرور، در صورتی که دو یا چند سفارش با پارامترهای ورودی کاملاً مشابه از جمله نوع و قیمت و مقدار، در بازه‌ی زمانی کمتر از ده ثانیه ارسال نمایید، تنها سفارش اول پذیرفته می‌شود و باقی درخواست‌های مشابه تا ده ثانیه پیام خطای DuplicateOrder دریافت می‌کنند. (غیرفعال در حالت Pro) توصیه می‌شود در صورت استفاده از این حالت Pro حتما از پارامتر clientOrderId استفاده نمایید تا از ثبت سفارش تکراری ناشی از اختلالات شبکه و سرور جلوگیری نماید.

مشاهده وضعیت سفارش

curl 'https://api.nobitex.ir/market/orders/status' \
  -X POST \
  -H "Authorization: Token yourTOKENhereHEX0000000000" \
  -H "content-type: application/json" \
  --data '{"id":5684}'

http POST https://api.nobitex.ir/market/orders/status \
  id=5684

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
    "status": "ok",
    "order": {
        "unmatchedAmount": "3.0000000000",
        "fee": "0E-10",
        "matchedAmount": "0E-10",
        "partial": false,
        "price": "8500000.0000000000",
        "created_at": "2018-11-28T12:25:22.696029+00:00",
        "id": 5684,
        "srcCurrency": "Litecoin",
        "totalPrice": "25500000.00000000000000000000",
        "type": "sell",
        "dstCurrency": "\ufdfc",
        "isMyOrder": false,
        "status": "Active",
        "amount": "3.0000000000",
        "clientOrderId": "order1"
    }
}

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

• درخواست: POST /market/orders/status
• محدودیت فراخوانی: 60 درخواست در هر دقیقه

پارامترهای ورودی:

نکات و ملاحظات

1. حتما باید حداقل یکی از دو پارامتر ‍order و clientOrderId ارسال شوند.
2. اگر هر دو پارامتر ‍order و clientOrderId ارسال شوند، اولویت با id است.
3. clientOrderId فقط در میان سفارشات open/active/inactive جستجو میشود.
4. clientOrderId .در حالت آزمایشی است و ممکن است در آینده تغییر کند

انواع مقادیر status:

• Active: سفارش مقدار پر نشده (unmatched_amount) برای شرکت در معاملات دارد و در بازار فعال است.
• Done: سفارش تماما معامله شده است.
• Inactive: سفارش حد ضرر هنوز به محدوده قیمت توقف تعیین شده نرسیده و غیرفعال است.
• Canceled: سفارش پیش از پر شدن کامل توسط کاربر یا سامانه لغو شده است. سفارش به چند دلیل می‌تواند توسط سامانه لغو شود:
  • مقدار سفارش کافی در بازار در بازه ۱٪ قیمت تعیین شده برای پر کردن سفارش وجود نداشته است.
  • موجودی کیف پول کاربر از طریق سایر تراکنش‌ها کاهش یافته است و از موجودی لازم برای پر شدن معامله کمتر شده است.

حالت‌های خطا

در صورت عدم پذیرش سفارش، پاسخ به این صورت خواهد بود:

{
  "status": "failed",
  "code": "ErrorCode",
  "message": "Human readable error message"
}

فهرست سفارش‌های کاربر

curl 'https://api.nobitex.ir/market/orders/list?srcCurrency=btc&dstCurrency=usdt&details=2' \
  -H "Authorization: Token yourTOKENhereHEX0000000000"

http GET https://api.nobitex.ir/market/orders/list \
  srcCurrency=btc dstCurrency=usdt details=2

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
  "status": "ok",
  "orders": [
    {
      "id": 173546223,
      "type": "sell",
      "execution": "Limit",
      "status": "Active",
      "srcCurrency": "Bitcoin",
      "dstCurrency": "Tether",
      "price": "9750.01",
      "amount": "0.0123",
      "matchedAmount": "0E-10",
      "averagePrice": "0",
      "fee": "0E-10",
      "clientOrderId": "order1"
    }
  ]
}

برای دریافت فهرست سفارش‌های خود، از این درخواست استفاده نمایید.

• درخواست: GET /market/orders/list
• محدودیت فراخوانی: 30 درخواست در دقیقه
• صفحه بندی: دارد (پیش فرض ۱۰۰۰)

پارامترهای ورودی

توضیحات تکمیلی پارامترهای ورودی

• وضعیت سفارش یکی از مقادیر زیر می‌تواند باشد:
  • all: سفارش‌های در تمامی وضعیت‌ها در پاسخ بازگردانده می‌شوند.
  • open: سفارش‌های باز، شامل سفارش‌های فعال و غیرفعال بازگردانده می‌شوند. منظور از سفارش‌های باز غیرفعال، مثلاً سفارش‌های حد ضرری است که هنوز فعال نشده باشند.
  • done: سفارش‌هایی که بخشی یا تمام آن پر شده باشند بازگردانده می‌شوند.
  • close: سفارش‌هایی که وضعیت آن‌ها «انجام شده» یا «لغو شده» باشد بازگردانده می‌شوند.
• دو وضعیت active و undone از موارد قدیمی بوده و دیگر پشتیبانی نمی‌شوند.

پارامترهای پاسخ

شی Order

همچنین در صورتی که پارامتر details=2 باشد این فیلدها نیز برای هر سفارش بازگردانده می‌شود:

نکات و ملاحظات

1. در پاسخ حداکثر اطلاعات هزار سفارش بازگردانده می‌شود. با استفاده از پارامترهای ورودی می‌توانید تعداد محدودتری از سفارش‌های خود را دریافت کنید. همچنین پیشنهاد می‌شود که در صورتی که تعداد زیادی سفارش باز دارید، شناسه آن‌ها را در زمان ثبت سفارش دریافت و ذخیره نمایید و به صورت مستقل با استفاده از درخواست «مشاهده وضعیت سفارش» اطلاعات هر یک را بنا به نیاز به‌روز کنید. همچنین برای اطلاع از معاملات انجام شده خود می‌توانید از درخواست فهرست معاملات کاربر استفاده نمایید.
2. منظور از وضعیت Done سفارشی است که به صورت صد در صد اجرا شده باشد. ممکن است سفارش شما به تدریج اجرا شود، و در این حالت وضعیت آن کماکان Active می‌ماند. از فیلد matchedAmount برای تشخیص وضعیت اجرا و پر شدن سفارش استفاده کنید. همچنین ممکن است سفارش شما قبل از اجرای کامل، به دلیل درخواست «لغو سفارش» یا کمبود موجودی یا تغییر شدید قیمت بازار (در سفارش‌های مارکت) لغو شود که در این حالت وضعیت آن Canceled خواهد بود، به این معنی که به صورت صد در صد اجرا نشده است ولی می‌تواند مقدار matchedAmount آن بزرگ‌تر از صفر باشد.
3. این API متناظر مواردی مانند Current Open Orders و All Orders در اکسچنج بایننس است.

تغییر وضعیت سفارش

curl 'https://api.nobitex.ir/market/orders/update-status' \
  -X POST \
  -H "Authorization: Token yourTOKENhereHEX0000000000" \
  -H "content-type: application/json" \
  --data '{"order":5684,"status":"canceled"}'

http POST https://api.nobitex.ir/market/orders/update-status \
  order=5684 status=canceled

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
    "status": "ok",
    "updatedStatus": "Canceled"
}

برای تغییر وضعیت یک سفارش (لغو یا فعال‌سازی) از این نوع درخواست استفاده نمایید:

• درخواست: POST /market/orders/update-status
• محدودیت فراخوانی: 60 درخواست در دقیقه

پارامترهای ورودی

نکات و ملاحظات

1. حتما باید حداقل یکی از دو پارامتر ‍order و clientOrderId ارسال شوند.
2. اگر هر دو پارامتر ‍order و clientOrderId ارسال شوند، اولویت با id است.
3. clientOrderId فقط در میان سفارشات open/active/inactive جستجو میشود.
4. clientOrderId .در حالت آزمایشی است و ممکن است در آینده تغییر کند
5. مقدار status میتواند از 'new' به 'active' و یا از 'active'/'inactive' به 'cancel' تغییر کند. در غیر اینصورت، درخواست رد میشود.
6. در صورتی که سفارش درخواست شده جزئی از یک سفارش OCO انجام نشده باشد، هر دو سفارش مرتبط لغو خواهند شد.

حالت‌های خطا

در صورت عدم پذیرش سفارش، پاسخ به این صورت خواهد بود:

{
  "status": "failed",
  "code": "ErrorCode",
  "message": "Human readable error message"
}

لغو جمعی سفارشات

curl 'https://api.nobitex.ir/market/orders/cancel-old' \
  -X POST \
  -H "Authorization: Token yourTOKENhereHEX0000000000" \
  -H "content-type: application/json" \
  --data '{"execution":"limit","srcCurrency":"btc","dstCurrency":"rls","hours":2.4}'

http POST https://api.nobitex.ir/market/orders/cancel-old \
  execution=limit srcCurrency=btc dstCurrency=rls hours=2.4

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
    "status": "ok"
}

برای لغو دسته‌جمعی سفارشات فعال از این نوع درخواست استفاده نمایید:

• درخواست: POST /market/orders/cancel-old
• محدودیت فراخوانی: 10 درخواست در دقیقه

پارامترهای ورودی

نکات و ملاحظات

1. مقدار hours در واقع مقدار ساعت قبل از زمان ارسال درخواست میباشد. برای مثال اگر مقدار ساعت '2' ارسال شود، سفارش های 2 ساعت قبل لغو خواهند شد.
2. در صورتی که مقدار hours ارسال نشود، تمامی سفارشات فعال مربوط لغو خواهد شد.
3. سفارشات حد ضرر غیرفعال غیر OCO مشمول این نوع لغو نخواهند شد.
4. در بعضی شرایط امکان دارد به شما خطا پاسخ داده شود. این خطاها در فیلد error برگردانده میشوند.

حالت‌های خطا

در صورت عدم پذیرش سفارش، پاسخ به این صورت خواهد بود:

{
  "status": "failed",
  "code": "ErrorCode",
  "message": "Human readable error message"
}

فهرست معاملات کاربر

curl 'https://api.nobitex.ir/market/trades/list?srcCurrency=usdt&dstCurrency=rls' \
  -H "Authorization: Token yourTOKENhereHEX0000000000"

http GET https://api.nobitex.ir/market/trades/list?srcCurrency=usdt&dstCurrency=rls

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
  "status": "ok",
  "trades": [
    {
      "id": 123412,
      "orderId": 1231222,
      "srcCurrency": "Tether",
      "dstCurrency": "﷼",
      "market": "USDT-RLS",
      "timestamp": "2022-07-05T09:57:38.560820+00:00",
      "type": "sell",
      "price": "316800",
      "amount": "57.3605",
      "total": "18171806.4",
      "fee": "27257.7096"
    }
  ],
  "hasNext": false
}

برای دریافت فهرست معاملات ۳ روز اخیر خود، از این درخواست استفاده نمایید.

• درخواست: GET /market/trades/list
• محدودیت فراخوانی: 20 درخواست در دقیقه
• صفحه بندی: دارد (پیش فرض ۳۰)

پارامترهای ورودی

• در فیلتر بازار هر دو پارامتر رمزارز مبدا و مقصد باید مقدار داشته باشند یا هر دو خالی باشند.
• در صورت اختصاص مقدار به حداقل شناسه تنها معاملاتی که شناسه‌ی آن‌ها بیشتر از یا مساوی با حداقل شناسه است برگردانده می‌شوند.

پارامترهای پاسخ

شی Trade

معامله در بازار تعهدی

موقعیت خرید و فروش تعهدی امکان معامله وکالتی را برای کاربران فراهم می‌کند. استفاده از این ویژگی به منزله پذیرش شروط، قوانین و ضوابط معاملات تعهدی در نوبیتکس است.

مشاهده بازارهای معاملات تعهدی

curl 'https://api.nobitex.ir/margin/markets/list' \
  -H "Authorization: Token yourTOKENhereHEX0000000000"

http GET https://api.nobitex.ir/margin/markets/list

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
  "status": "ok", 
  "markets": {
    "BTCIRT": {
      "srcCurrency": "btc",
      "dstCurrency": "rls",
      "positionFeeRate": "0.001",
      "maxLeverage": "5",
      "sellEnabled": true,
      "buyEnabled": false
    },
    "BTCUSDT": {
      "srcCurrency": "btc",
      "dstCurrency": "usdt",
      "positionFeeRate": "0.001",
      "maxLeverage": "5",
      "sellEnabled": true,
      "buyEnabled": true
    },
    "DOGEIRT": {
      "srcCurrency": "doge",
      "dstCurrency": "rls",
      "positionFeeRate": "0.001",
      "maxLeverage": "4",
      "sellEnabled": true,
      "buyEnabled": false
    },
    "DOGEUSDT": {
      "srcCurrency": "doge",
      "dstCurrency": "usdt",
      "positionFeeRate": "0.001",
      "maxLeverage": "3",
      "sellEnabled": true,
      "buyEnabled": true
    }
  }
}

برای دریافت بازارهای پشتیبانی شده برای معاملات تعهدی از این درخواست استفاده نمایید.

• درخواست:: GET /margin/markets/list
• محدودیت فراخوانی: ۳۰ درخواست در هر دقیقه

پارامترهای پاسخ

شی MarginMarketSetting

نکات و ملاحظات

1. بیشینه ضریب مجاز بازار هم به عمق بازار و هم به سطح کاربری وابسته است. بدین منظور برای دریافت مقدار دقیق با توجه سطح کاربری تان، درخواست را همراه با توکن احراز هویت خود ارسال نمایید.
2. نرخ کارمزد تمدید روزانه به صورت پله‌ای بر اساس ارزش دارایی وکالت گرفته شده تعیین می‌شود. برای اطلاعات بیشتر به قوانین معاملات تعهدی مراجعه نمایید.

مشاهده استخرهای مشارکت ارزی فعال

curl 'https://api.nobitex.ir/liquidity-pools/list' \
  -H "Authorization: Token yourTOKENhereHEX0000000000"

http GET https://api.nobitex.ir/liquidity-pools/list

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
  "status": "ok", 
  "pools": {
    "btc": {
      "capacity": "30",
      "filledCapacity": "28.082343",
      "availableBalance": "15.879876"
    },
    "ltc": {
      "capacity": "160",
      "filledCapacity": "149.234",
      "availableBalance": "63.987"
    },
    "doge": {
      "capacity": "5000000",
      "filledCapacity": "5000000",
      "availableBalance": "120890.34"
    }
  }
}

استخرهای مشارکت موجودی مورد نیاز برای اعطای وکالت خرید و فروش تعهدی را تامین می‌کنند. ظرفیت مشارکت افراد در معاملات تعهدی را موجودی استخرها تعیین می‌کنند. استخرها ممکن است در زمان‌هایی فعال و غیرفعال شوند. در استخرهای غیرفعال امکان ثبت سفارش جدید تعهدی وجود ندارد (اما بستن موقعیت همچنان میسر است). برای دریافت ظرفیت استخرهای فعال از این درخواست استفاده نمایید.

• درخواست:: GET /liquidity-pools/list
• محدودیت فراخوانی: ۱۲ درخواست در هر دقیقه

انتقال پول به کیف‌پول تعهدی

curl -X POST 'https://api.nobitex.ir/wallets/transfer' \
  -H "Authorization: Token yourTOKENhereHEX0000000000" \
  -H "content-type: application/json" \
  --data '{"currency": "rls", "amount": "2500000000", "src": "spot", "dst": "margin"}'

http POST https://api.nobitex.ir/liquidity-pools/list \
  currency=rls&amount=2500000000&src=spot&dst=margin

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
  "status": "ok", 
  "srcWallet": {
    "id": 53456,
    "currency": "rls",
    "balance": "1870000000",
    "blockedBalance": "420000000",
    "activeBalance": "1450000000",
    "rialBalance": "1870000000",
    "rialBalanceSell": "1870000000",
    "depositAddress": null,
    "depositTag": null,
    "depositInfo": {
      "FIAT_MONEY": {
        "address": null,
        "tag": null
      }
    }
  },
  "dstWallet": {
    "id": 86459,
    "currency": "rls",
    "balance": "2500000000",
    "blockedBalance": "0",
    "activeBalance": "2500000000",
    "rialBalance": "2500000000",
    "rialBalanceSell": "2500000000"
  }
}

وجوه تضمین قبل از دریافت وکالت خرید و فروش تعهدی باید در کیف‌پول تعهدی قرار گیرند. برای انتقال موجودی میان دو کیف‌پول اسپات و تعهدی از این درخواست استفاده نمایید.

• درخواست:: POST /wallets/transfer
• محدودیت فراخوانی: ۱۰ درخواست در هر دقیقه

پارامترهای ورودی

نکات و ملاحظات

1. نوع کیف‌پول مبدا و مقصد نباید یکسان باشد.
2. کیف‌پول تعهدی ضمن اولین انتقال به آن ایجاد می‌شود. پس از آن موجودی این کیف‌پول را می‌توان از طریق لیست کیف‌پول‌ها مشاهده کرد.

حالت‌های خطا

در صورت عدم پذیرش درخواست، پاسخ به این صورت خواهد بود:

{
  "status": "failed",
  "code": "InsufficientBalance",
  "message": "Amount cannot exceed active balance"
}

دریافت محدودیت کاربری در مقدار وکالت

curl 'https://api.nobitex.ir/margin/delegation-limit?currency=btc' \
  -H "Authorization: Token yourTOKENhereHEX0000000000" 

http GET https://api.nobitex.ir/margin/delegation-limit \
  currency=btc

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
  "status": "ok",
  "limit": "0.039062"
}

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

• درخواست:: GET /margin/delegation-limit
• محدودیت فراخوانی: ۱۲ درخواست در هر دقیقه

پارامترهای ورودی

حالت‌های خطا

در صورت عدم پذیرش درخواست، پاسخ به این صورت خواهد بود:

{
  "status": "failed",
  "code": "ErrorCode",
  "message": "Human readable error message"
}

نکات و ملاحظات

1. با هر بار باز کردن سفارش جدید، این سقف کاهش یافته و با بستن موقعیت و تسویه این سقف افزایش می‌یابد. به نوعی این مقدار برابر میزان باقیمانده از مقدار مجاز کاربری شما بری وکالت گیری می‌باشد.
2. مقدار هر سفارش فروش تعهدی باید همواره از سقف وکالت باقیمانده رمزارز مبدا کمتر باشد.
3. ارزش کل هر سفارش خرید تعهدی (قیمت × مقدار) باید همواره از سقف وکالت باقیمانده ارز مقصد کمتر باشد.

درج سفارش تعهدی

curl -X POST 'https://api.nobitex.ir/margin/orders/add' \
  -H "Authorization: Token yourTOKENhereHEX0000000000" \
  -H "content-type: application/json" \
  --data '{"srcCurrency": "btc", "dstCurrency": "rls", "leverage": "2", "amount": "0.01", "price": "6400000000"}'

http POST https://api.nobitex.ir/margin/orders/add \
  srcCurrency=btc&dstCurrency=rls&amount=0.01&price=6400000000

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
  "status": "ok",
  "order": {
    "id": 25,
    "type": "sell",
    "execution": "Limit",
    "tradeType": "Margin",
    "srcCurrency": "btc",
    "dstCurrency": "rls",
    "price": "6400000000",
    "amount": "0.01",
    "status": "Active",
    "totalPrice": "0",
    "totalOrderPrice": "64000000",
    "matchedAmount": 0,
    "unmatchedAmount": "0.01",
    "leverage": "2",
    "side": "open",
    "partial": false,
    "fee": 0,
    "created_at": "2022-10-20T11:36:13.592827+00:00",
    "averagePrice": "0"
  }
}

برای درج سفارش در بازار تعهدی از این درخواست استفاده نمایید.

• درخواست:: POST /margin/orders/add
• محدودیت فراخوانی: ۱۰۰ درخواست در هر ۱۰ دقیقه

پارامترهای ورودی

پارامترهای پاسخ

سفارش OCO

پارامترهای پاسخ OCO

نکات و ملاحظات

1. نوع اجرای سفارش یکی از موارد زیر می‌باشد:
   • limit: با قیمت معین
   • market: با قیمت بازار
   • stop_limit: حد ضرر با قیمت معین
   • stop_market: حد ضرر با قیمت بازار
2. سفارش‌های خرید و فروش تعهدی ثبت شده را می‌توان در فهرست سفارش‌های کاربر مشاهده کرد.
3. بعد از پر شدن سفارش تعهدی، موقعیت متناظر با آن باز خواهد شد.
4. شرط قیمت سفارش OCO:
   • خرید: price < آخرین قیمت بازار < stopPrice و stopLimitPrice
   • فروش: price > آخرین قیمت بازار > stopPrice و stopLimitPrice
5. ضریب عددی در محدوده 1 تا ضریب بیشینه هر بازار با دقت 0.5 است، مانند: 1, 1,5, 2, 2,5 و ...

حالت‌های خطا

در صورت عدم پذیرش درخواست، پاسخ به این صورت خواهد بود:

{
  "status": "failed",
  "code": "ErrorCode",
  "message": "Human readable error message"
}

مشاهده لیست موقعیت‌ها

curl 'https://api.nobitex.ir/positions/list?srcCurrency=btc&status=active' \
  -H "Authorization: Token yourTOKENhereHEX0000000000" 

http GET https://api.nobitex.ir/positions/list \
  srcCurrency=btc&status=active

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
  "status": "ok",
  "positions": [
    {
      "id": 128,
      "createdAt": "2022-10-20T11:36:13.604420+00:00",
      "srcCurrency": "btc",
      "dstCurrency": "rls",
      "side": "sell",
      "status": "Open",
      "marginType": "Isolated Margin",
      "collateral": "320000000",
      "leverage": "2",
      "openedAt": "2022-10-20T11:36:16.562038+00:00",
      "closedAt": null,
      "liquidationPrice": "25174302690",
      "entryPrice": "6400000000",
      "exitPrice": null,
      "delegatedAmount": "0.03",
      "liability": "0.0300450676",
      "totalAsset": "831712000",
      "marginRatio": "1.49",
      "liabilityInOrder": "0",
      "assetInOrder": "0",
      "unrealizedPNL": "−576435",
      "unrealizedPNLPercent": "−0.09",
      "expirationDate": "2022-11-20",
      "extensionFee": "320000"
    },
    {
      "id": 32,
      "createdAt": "2022-08-14T15:09:58.001901+00:00",
      "srcCurrency": "btc",
      "dstCurrency": "usdt",
      "side": "sell",
      "status": "Closed",
      "marginType": "Isolated Margin",
      "collateral": "2130",
      "leverage": "1",
      "openedAt": "2022-08-14T15:10:19.937801+00:00",
      "closedAt": "2022-08-17T18:39:52.890674+00:00",
      "liquidationPrice": "38986.54",
      "entryPrice": "21300",
      "exitPrice": "19900",
      "PNL": "118.46",
      "PNLPercent": "5.56"
    }
  ],
  "hasNext": false
}

برای دریافت لیست موقعیت‌های باز و تاریخچه موقعیت‌های پایان یافته از این درخواست استفاده کنید.

• درخواست:: GET /positions/list

• محدودیت فراخوانی: ۳۰ درخواست در هر دقیقه

• صفحه‌بندی: دارد (پیش فرض ۵۰)

پارامترهای ورودی

پارامترهای پاسخ

شی Position

نکات و ملاحظات

1. وضعیت: این پارامتر در ورودی بر دو قسم است:
   • active: موقعیت‌های باز و تسویه نشده
   • past: موقعیت‌های بسته، لیکوئید و منقضی شده که تسویه شده باشد
     همچنین در خروجی بر چند مقدار است:
   • Open: باز -- همه یا بخشی از سفارش تعهدی در بازار پر شده است.
   • Closed: بسته -- کاربر مقدار وکالت گرفته شده را بازپرداخت کرده است.
   • Liquidated: لیکویید شده
   • Expired: منقضی شده -- هر موقعیت از زمان ثبت سفارش اولیه حداکثر ۳۰ روز می‌تواند باز بماند.
2. نوع تضمین سفارش: بر دو قسم می‌تواند باشد.
   • Isolated Margin: ضرر حداکثر به اندازه وجه تضمین موقعیت خواهد بود. -- پیش‌فرض
   • Cross Margin: ضرر حداکثر به اندازه تمام موجودی آزاد کیف‌پول تعهدی خواهد بود. -- در آینده
3. تعهد خرید: مقدار وکالت گرفته شده + کارمزد سفارش خرید در موقعیت فروش یا - کارمزد سفارش خرید در موقعیت خرید
4. دارایی کلی: مقدار وجه تضمین + باقی‌مانده وجه حاصل از فروش در موقعیت فروش یا ارزش لحظه‌ای دارایی خریداری شده در موقعیت خرید
5. نسبت تعهد: نسبت اولیه آن ۲ و حداقل نسبت لازم برای لیکوئید نشدن ۱.۱ است.
6. از زمان لیکویید/منقضی شدن یک موقعیت باز تا زمان تسویه تعهد با سفارش‌گذاری سیستمی و معامله در بازار، ممکنه است اندکی فاصله ایجاد شود. در این بازه، موقعیت لیکویید/منقضی شده به منزله موقعیت فعال باز می‌گردد.

حالت‌های خطا

در صورت عدم پذیرش درخواست، پاسخ به این صورت خواهد بود:

{
  "status": "failed",
  "code": "ErrorCode",
  "message": "Human readable error message"
}

مشاهده یک موقعیت

curl 'https://api.nobitex.ir/positions/128/status' \
  -H "Authorization: Token yourTOKENhereHEX0000000000" 

http GET https://api.nobitex.ir/positions/128/status

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
  "status": "ok",
  "position": {
    "id": 128,
    "createdAt": "2022-10-20T11:36:13.604420+00:00",
    "srcCurrency": "btc",
    "dstCurrency": "rls",
    "side": "sell",
    "status": "Open",
    "marginType": "Isolated Margin",
    "collateral": "320000000",
    "leverage": "2",
    "openedAt": "2022-10-20T11:36:16.562038+00:00",
    "closedAt": null,
    "liquidationPrice": "25174302690",
    "entryPrice": "6400000000",
    "exitPrice": null,
    "delegatedAmount": "0.03",
    "liability": "0.0300450676",
    "totalAsset": "831712000",
    "marginRatio": "1.49",
    "liabilityInOrder": "0",
    "assetInOrder": "0",
    "unrealizedPNL": "−576435",
    "unrealizedPNLPercent": "−0.09",
    "expirationDate": "2022-11-20",
    "extensionFee": "320000"
  }
}

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

• درخواست:: GET /positions/:positionId:/status
• محدودیت فراخوانی: ۱۰۰ درخواست در هر ۱۰ دقیقه

پارامترهای ورودی

پارامترهای پاسخ

بستن موقعیت

curl -X POST 'https://api.nobitex.ir/positions/128/close' \
  -H "Authorization: Token yourTOKENhereHEX0000000000" \
  -H "content-type: application/json" \
  --data '{"amount": "0.0100150225", "price": "6200000000"}'

http POST https://api.nobitex.ir/positions/128/close \
  amount=0.0100150225&price=6200000000

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
  "status": "ok",
  "order": {
    "id": 28,
    "type": "buy",
    "execution": "Limit",
    "tradeType": "Margin",
    "srcCurrency": "btc",
    "dstCurrency": "rls",
    "price": "6200000000",
    "amount": "0.0100150225",
    "status": "Active",
    "totalPrice": "0",
    "totalOrderPrice": "62093139",
    "matchedAmount": 0,
    "unmatchedAmount": "0.0100150225",
    "leverage": "2",
    "side": "close",
    "partial": false,
    "fee": 0,
    "created_at": "2022-10-25T09:57:38.560820+00:00",
    "averagePrice": "0"
  }
}

برای بستن موقعیت با درج سفارش در جهت عکس سفارش اولیه جهت تسویه تعهد از این درخواست استفاده نمایید. به عبارتی با خرید تعهد موقعیت فروش یا فروش تعهد موقعیت خرید موقعیت شما قابل بسته شدن خواهد شد.

• درخواست:: POST /positions/:positionId:/close
• محدودیت فراخوانی: ۳۰۰ درخواست در هر دقیقه

پارامترهای ورودی

پارامترهای پاسخ

سفارش OCO

پارامترهای پاسخ OCO

نکات و ملاحظات

1. نوع اجرای سفارش یکی از موارد زیر می‌باشد:
   • limit: با قیمت معین
   • market: با قیمت بازار
   • stop_limit: حد ضرر با قیمت معین
   • stop_market: حد ضرر با قیمت بازار
2. سفارش‌های خرید و فروش تعهدی ثبت شده را می‌توان فهرست سفارش‌های کاربر مشاهده کرد.
3. بعد از پر شدن سفارش تسویه تعهد، موقعیت بسته و سود و زیان آن واریز خواهد شد.
4. سفارش‌های تسویه از دارایی کلی موقعیت تامین اعتبار می‌شوند. مقدار سفارش تسویه باید شروط زیر را داشته باشد:
   • مجموع مقدار باز سفارشات تسویه موقعیت از تعهد موقعیت بیشتر نباشد. (liability - liabilityInOrder)
   • در صورتی که مقدار با همه تعهد باقیمانده برابر نباشد --تسویه نهایی--، سفارش کوچک نباشد. (مثال: فرض کنید می‌خواهید موقعیت فروش ۰.۰۰۱ بیت‌کوین را با ارزش ۶۴۰ هزار تومان تسویه کنید و کف سفارش کوچک ۳۰۰ هزار تومان باشد. می‌توانید ۲ سفارش ۳۰۰ هزار تومانی خرید بگذارید. و در پایان برای ۴۰ هزار تومان باقیمانده سفارش کوچک بگذارید. اما نمی‌توانید سفارش‌های اولیه را کمتر از ۳۰۰ هزار تومان قرار دهید. -- مشابه تبدیل موجودی اندک در کیف پول)
   • ارزش کل بخش باز سفارش‌های خرید تسویه (موجودی ضرب در قیمت) از دارایی کلی موقعیت فروش بیشتر نباشد. (totalAsset - assetInOrder)
5. دقت کنید تعهد موقعیت حداکثر ۱۰ رقم دقت دارد که در زمان تسویه نهایی همه آن باید ارسال شود.
6. شرط قیمت سفارش OCO:
   • بستن فروش (با سفارش خرید): price < آخرین قیمت بازار < stopPrice و stopLimitPrice
   • بستن خرید (با سفارش فروش): price > آخرین قیمت بازار > stopPrice و stopLimitPrice

حالت‌های خطا

در صورت عدم پذیرش درخواست، پاسخ به این صورت خواهد بود:

{
  "status": "failed",
  "code": "ErrorCode",
  "message": "Human readable error message"
}

ویرایش وجه تضمین موقعیت باز

curl -X POST 'https://api.nobitex.ir/positions/128/edit-collateral' \
  -H "Authorization: Token yourTOKENhereHEX0000000000" \
  -H "content-type: application/json" \
  --data '{"collateral": "230000000"}'

http POST https://api.nobitex.ir/positions/128/edit-collateral \
  collateral=230000000

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
  "status": "ok",
  "position": {
    "id": 128,
    "createdAt": "2022-10-20T11:36:13.604420+00:00",
    "srcCurrency": "btc",
    "dstCurrency": "rls",
    "side": "sell",
    "status": "Open",
    "marginType": "Isolated Margin",
    "collateral": "230000000",
    "leverage": "2",
    "openedAt": "2022-10-20T11:36:16.562038+00:00",
    "closedAt": null,
    "liquidationPrice": "12230682570",
    "entryPrice": "6400000000",
    "exitPrice": "6100000000",
    "PNL": null,
    "delegatedAmount": "0.02",
    "liability": "0.0200300451",
    "totalAsset": "257023981",
    "marginRatio": "2.03",
    "liabilityInOrder": "0",
    "assetInOrder": "0",
    "unrealizedPNL": "23423565",
    "unrealizedPNLPercent": "10.18",
    "expirationDate": "2022-11-20",
    "extensionFee": "320000"
  }
}

برای کاهش یا افزایش وجه تضمین موقعیت باز خود از این درخواست استفاده نمایید.

• درخواست:: POST /positions/:positionId:/edit-collateral
• محدودیت فراخوانی: ۶۰ درخواست در هر دقیقه

پارامترهای ورودی

پارامترهای پاسخ

نکات و ملاحظات

1. در صورتی که موقعیت در سوددهی باشد (نسبت تعهد > نسبت تعهد اولیه = ضریب / 1 + 1)، کاربر می‌تواند مازاد وجه تضمین خود را تا نسبت تعهد اولیه از بلوکه در بیاورد. -- سود تنها زمان بسته شدن کامل موقعیت قابل دستیابی است.
2. در صورتی که موقعیت به نقطه لیکوئید شدن نزدیک باشد و کاربر بخواهد موقعیت خود (به امید تغییر جهت بازار) باز نگهدارد، می‌تواند با افزایش وجه تضمین خود، قیمت لیکوئید شدن خود را بهبود دهد.

حالت‌های خطا

در صورت عدم پذیرش درخواست، پاسخ به این صورت خواهد بود:

{
  "status": "failed",
  "code": "ErrorCode",
  "message": "Human readable error message"
}

برداشت

ثبت درخواست برداشت

curl -X POST 'https://api.nobitex.ir/users/wallets/withdraw' \
  -H 'Authorization: Token yourTOKENhereHEX0000000000' \
  -H 'X-TOTP: 123456' \
  -H 'Content-Type: application/json' \
  --data '{"wallet": 3456, "invoice": "lnbc123m1pskcu80pp5qqqsyqcyq5rqwz..."}'

http POST https://api.nobitex.ir/users/wallets/withdraw \
  wallet=3456 invoice=lnbc123m1pskcu80pp5qqqsyqcyq5rqwz...

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
  "status": "ok",
  "withdraw": {
    "id": 432,
    "createdAt": "2021-12-11T10:13:42.957103+00:00",
    "status": "New",
    "amount": "0.0123",
    "currency": "btc",
    "network": "BTCLN",
    "invoice": "lnbc123m1pskcu80pp5qqqsyqcyq5rqwz...",
    "address": "SaMpLeWaLlEtAdDrEsS",
    "tag": "123456",
    "wallet_id": 3456,
    "blockchain_url": "https://nobitex.ir/receipt/Bitcoin/ewd23d...",
    "is_cancelable": true
  }
}

در صورت وجود داشتن آدرس مقصد در دفتر آدرس، نیازی به ارسال X-TOTP در هدر درخواست نیست.

در صورت نبودن آدرس مقصد در دفتر آدرس، پس از ثبت درخواست برداشت، یک کد تایید یکبارمصرف به کاربر ایمیل و پیامک می‌شود.

برای ثبت درخواست برداشت از این نوع درخواست استفاده نمایید:

• درخواست: POST /users/wallets/withdraw
• محدودیت فراخوانی: 10 درخواست در 3 دقیقه

پارامترهای ورودی

1. شبکه انتقال: مقادیر قابل قبول است. در مواردی که چند شبکه برداشت برای رمزارز درخواستی پشتیبانی می‌شود، می‌توان شبکه انتقال را تعیین نمود.
2. صورت‌حساب: در انتقال‌های شبکه BTCLN الزامی است. در صورت وجود invoice پارامترهای amount و address از آن استخراج شده و در بدنه درخواست بلااستفاده خواهند شد. شبکه صورت‌حساب باید با network در صورت مشخص شدن در درخواست مطابقت داشته باشد.
3. مقدار: در صورتی که بدون invoice درخواست برداشت ثبت می‌کنید، الزامی می‌شود.
4. آدرس مقصد: برای برداشت‌های ریالی شناسه حساب بانکی تایید شده کاربر جهت دریافت وجه و برای برداشت‌های رمزارزی آدرس کیف پول مقصد می‌باشد. در صورتی که از invoice برای برداشت استفاده می‌کنید، بلااستفاده خواهد شد.
5. بدون تگ: برای برداشت از شبکه‌های که تگ انتقال در آن‌ها ضروری است بدون درج تگ، مقدار آن را true قرار دهید.
6. تگ انتقال: در شبکه‌های بدون فعال کردن noTag الزامی است.

حالت‌های خطا

در صورتی که درخواست برداشت معتبر نباشد، ممکن است یکی از این خطاها برگردانده شود. در صورت دریافت هر یک از این خطاها، درخواست شما ثبت نشده است و در صورت تمایل باید درخواست را دوباره ارسال کنید.

نکات و ملاحظات

1. در صورت موجود نبودن آدرس مقصد در دفتر آدرس، این درخواست نیاز به شناسایی دوعاملی دارد.
2. کاربر درخواست دهنده بایستی اجازه برداشت از کیف پول خود را داشته باشد. (مثلا دارای حداقل سطح مجاز برای برداشت و شماره تماس تایید شده بوده و سقف برداشت مجاز روزانه و ماهانه خود را رد نکرده باشد و شرایط و پیشنیازات ذکر شده در مقررات نوبیتکس را رعایت کرده باشد.)
3. در صورت فعال بودن حالت برداشت امن، شبکه، آدرس (و در صورت الزام شبکه، تگ) انتخاب شده باید در دفتر آدرس شما ثبت شده باشد.
4. درخواست برداشت ثبت شده در این مرحله نیاز به تایید توسط کاربر دارد.

تایید درخواست برداشت

curl -X POST 'https://api.nobitex.ir/users/wallets/withdraw-confirm' \
  -H 'Authorization: Token yourTOKENhereHEX0000000000' \
  -H 'Content-Type: application/json' \
  --data '{"withdraw": 432, "otp": 623005}'

http POST https://api.nobitex.ir/users/wallets/withdraw-confirm \
  withdraw=432 otp=623005

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
  "status": "ok",
  "withdraw": {
    "id": 432,
    "createdAt": "2021-12-11T10:13:42.957103+00:00",
    "status": "Verified",
    "amount": "0.0123",
    "currency": "btc",
    "network": "BTCLN",
    "invoice": "lnbc123m1pskcu80pp5qqqsyqcyq5rqwz...",
    "address": "SaMpLeWaLlEtAdDrEsS",
    "tag": "123456",
    "wallet_id": 3456,
    "blockchain_url": "https://nobitex.ir/receipt/Bitcoin/ewd23d...",
    "is_cancelable": true
  }
}

برای تایید درخواست برداشت از این نوع درخواست استفاده نمایید:

• درخواست: POST /users/wallets/withdraw-confirm
• محدودیت فراخوانی: 30 درخواست در ساعت

پارامترهای ورودی

نکات و ملاحظات

1. در برداشت‌های ریالی به شبای تایید شده کاربر و برداشت رمزارزی به آدرس‌های امن دفتر آدرس، نیازی به ارسال رمز یکبارمصرف نیست.
2. برای تایید برداشت به آدرس‌های تایید نشده باید کد یکبارمصرف ارسال شده به شماره تلفن همراه یا ایمیل حساب کاربری خود را استخراج و به این API ارسال نمایید.
3. امکان استفاده از آی‌پی اختصاصی به زودی فراهم خواهد شد.

فهرست برداشت‌ها

curl 'https://api.nobitex.ir/users/wallets/withdraws/list' \
  -H 'Authorization: Token yourTOKENhereHEX0000000000'

http GET https://api.nobitex.ir/users/wallets/withdraws/list

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
  "status": "ok",
  "withdraws": [
    {
      "id": 432,
      "createdAt": "2021-12-11T10:13:42.957103+00:00",
      "status": "Canceled",
      "amount": "0.0123",
      "currency": "btc",
      "network": "BTCLN",
      "invoice": "lnbc123m1pskcu80pp5qqqsyqcyq5rqwz...",
      "address": "SaMpLeWaLlEtAdDrEsS",
      "tag": "123456",
      "wallet_id": 3456,
      "blockchain_url": "https://nobitex.ir/receipt/Bitcoin/ewd23d...",
      "is_cancelable": true
    },
    {
      "id": 238,
      "createdAt": "2020-09-19T14:17:23.441723+00:00",
      "status": "Done",
      "amount": "1000000",
      "currency": "rls",
      "network": "FIAT_MONEY",
      "invoice": null,
      "address": "\u062a\u062c\u0627\u0631\u062a: IR140180000000003333333333",
      "tag": null,
      "wallet_id": 3451,
      "blockchain_url": null,
      "is_cancelable": true
    },
    {
      "id": 239,
      "createdAt": "2018-10-04T12:59:38.196935+00:00",
      "status": "Done",
      "amount": "1",
      "currency": "ltc",
      "network": "LTC",
      "address": "Lgn1zc77mEjk72KvX...",
      "tag": null,
      "wallet_id": 3454,
      "blockchain_url": "https://live.blockcypher.com/ltc/tx/c1ed4229e598d4cf...",
      "is_cancelable": false
    }
  ],
  "hasNext": true
}