diff --git a/source/includes/_address_book.md b/source/includes/_address_book.md index 73e079a..f52f9c6 100644 --- a/source/includes/_address_book.md +++ b/source/includes/_address_book.md @@ -46,6 +46,10 @@ https GET https://apiv2.nobitex.ir/address_book - **درخواست:**: `GET /address_book` - **محدودیت فراخوانی:** 20 درخواست در هر دقیقه + + ### پارامترهای ورودی | پارامتر | نوع | پیش‌فرض | توضیحات | نمونه | @@ -95,6 +99,10 @@ curl -X POST 'https://apiv2.nobitex.ir/v2/otp/request' \ - **درخواست:**: `POST /address_book` - **محدودیت فراخوانی:** 6 درخواست در هر دقیقه + + ### پارامترهای ورودی | پارامتر | نوع | پیش‌فرض | توضیحات | نمونه | @@ -159,6 +167,10 @@ https DELETE /address_book//delete - **درخواست:**: `DELETE /address_book//delete` - **محدودیت فراخوانی:** 6 درخواست در هر دقیقه + + ### حالت‌های خطا > در صورت عدم پذیرش درخواست، پاسخ به این صورت خواهد بود: @@ -199,6 +211,10 @@ https POST https://apiv2.nobitex.ir/address_book/whitelist/activate - **درخواست:**: `POST /address_book/whitelist/activate` - **محدودیت فراخوانی:** 6 درخواست در هر دقیقه + + ## غیرفعال کردن برداشت امن با غیر فعال کردن برداشت امن، به جهت حفظ امنیت حساب امکان برداشت به مدت ۲۴ ساعت روی حساب کاربر محدود خواهد شد. @@ -224,6 +240,10 @@ https POST https://apiv2.nobitex.ir/address_book/whitelist/deactivate - **درخواست:**: `POST /address_book/whitelist/deactivate` - **محدودیت فراخوانی:** 6 درخواست در هر دقیقه + + ### پارامترهای ورودی | پارامتر | نوع | پیش‌فرض | توضیحات | نمونه | diff --git a/source/includes/_intro.md b/source/includes/_intro.md index afe19a9..410924a 100644 --- a/source/includes/_intro.md +++ b/source/includes/_intro.md @@ -49,25 +49,28 @@ Authorization: Token yourTOKENhereHEX0000000000 API ورود - دریافت توکن استفاده نمایید. ولی این کار ضروری نیست و روش پیشنهادی ما برای اغلب کاربران دریافت مستقیم توکن از پنل کاربری است. تنها در صورتی که با مخاطرات ذخیره گذرواژه خود در کد و روش‌های امن این کار آشنا هستید، در استفاده از API مهارت دارید، و از طرفی نیاز به دریافت کاملاً خودکار توکن دارید، از API دریافت توکن استفاده نمایید. -

کلید ای‌پی‌آی (آزمایشی)

+

کلید ای‌پی‌آی

کلید ای پی آی برای دسترسی امن تر و با مجوز مشخص به ای پی آی‌های نوبیتکس طراحی -شده است. +شده است. کلید ای پی آی به شما اجازه می‌دهد به صورت کنترل شده و از روی آی پی مشخص، به ای پی آی های نوبیتکس دسترسی داشته باشید و مدت زمان اعتبار کلید را مشخص کنید.

اهداف و کاربردها

چرا API Key؟

-- امنیت بیشتر (امکان تعریف سطح دسترسی محدود) با سه دسترسی READ, WITHDRAW, TRADE +- امنیت بیشتر (امکان تعریف سطح دسترسی محدود) با دسترسی‌های READ, WITHDRAW, TRADE, ADDRESS_BOOK, DEPOSIT, OTP, ... - پشتیبانی از **IP Whitelist** - قابلیت تنظیم تاریخ انقضای دلخواه - قابلیت غیرفعال‌سازی یا حذف بدون تغییر پسورد اصلی - مناسب برای ربات‌ها و اسکریپت‌های خودکار

سطوح دسترسی (Permissions)

-- **READ** →دریافت اطلاعات بدون تغییر در دیتابیس -- **TRADE** → عملیات‌های مربوط به معامله و ترید، که منجر به تغییری در دیتابیس می‌شوند. -- **WITHDRAW** → دسترسی عملیات برداشت +- **READ** →دریافت اطلاعات بدون تغییر در دیتابیس +- **TRADE** → عملیات‌های مربوط به معامله و ترید، که منجر به تغییری در دیتابیس می‌شوند. +- **WITHDRAW** → دسترسی عملیات برداشت +- **DEPOSIT** → دسترسی ساخت آدرس واریز رمزارزی +- **ADDRESS_BOOK** → دسترسی عملیات دفتر آدرس‌ها +- **OTP** → دسترسی دریافت کدهای یکبارمصرف از APIهای مرتبط توجه کنید که برای دسترسی به ای پی آی هایی مانند لیست سفارشات، دسترسی READ الزامی است. هر کلید می‌تواند یکی یا چند دسترسی داشته باشد. @@ -80,19 +83,19 @@ POST /apikeys/create

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

-| پارامتر | نوع | پیش‌فرض | توضیحات | نمونه | -|------------------------|----------------|-------------|--------------------------------------------------------------------------|---------------------------------------------| -| `name` | string | الزامی | نام کلید برای شناسایی توسط کاربر | `"my-api-key"` | -| `description` | string | خالی (`''`) | توضیحات دلخواه کاربر | `"API key for internal services"` | -| `permissions` | string (enum) | الزامی | مقادیر مجاز: `READ`, `TRADE`, `WITHDRAW` (به صورت رشته و جداشده با کاما) | `"READ,TRADE"` | -| `ipAddressesWhitelist` | list | `[]` | لیست آدرس‌های IP مجاز (IPv4/IPv6) | `["192.168.1.10", "10.0.0.5"]` | -| `expirationDate` | datetime (UTC) | `None` | تاریخ انقضای کلید (اختیاری) | `"2025-12-31T23:59:59Z"` | - +| پارامتر | نوع | پیش‌فرض | توضیحات | نمونه | +| ------------------------ | -------------- | ----------------- | -------------------------------------------------------------------------------------------------------------- | ----------------------------------- | +| `name` | string | الزامی | نام کلید برای شناسایی توسط کاربر | `"my-api-key"` | +| `description` | string | خالی (`''`) | توضیحات دلخواه کاربر | `"API key for internal services"` | +| `permissions` | string (enum) | الزامی | مقادیر مجاز:`READ`, `TRADE`, `WITHDRAW`, `DEPOSIT`, `ADDRESS_BOOK`, `OTP` (به صورت رشته و جداشده با کاما) | `"READ,TRADE"` | +| `ipAddressesWhitelist` | list | `[]` | لیست آدرس‌های IP مجاز (IPv4/IPv6)، با حداکثر ۱۵ آی‌پی | `["192.168.1.10", "10.0.0.5"]` | +| `expirationDate` | datetime (UTC) | `None` | تاریخ انقضای کلید (اختیاری) | `"2025-12-31T23:59:59Z"` |

نکات امنیتی

-- ارسال **OTP (2FA)** در هدر `X-totp` الزامی است. -- بعد از ایجاد کلید، یک **ایمیل اطلاع‌رسانی** برای کاربر ارسال می‌شود. -- رویداد ایجاد کلید در لاگ ثبت می‌شود. +- ارسال **OTP (2FA)** در هدر `X-totp` الزامی است. +- تعداد آی‌پی‌های `ipAddressesWhitelist` حداکثر ۱۵ مورد است. +- بعد از ایجاد کلید، یک **ایمیل اطلاع‌رسانی** برای کاربر ارسال می‌شود. +- رویداد ایجاد کلید در لاگ ثبت می‌شود. > نمونه درخواست @@ -111,7 +114,7 @@ POST /apikeys/create > نمونه پاسخ -```json +```json { "key": { "createdAt": "2025-09-02T16:50:29.381869Z", @@ -127,6 +130,7 @@ POST /apikeys/create "status": "ok" } ``` + ⚠️ توجه: کلید خصوصی (privateKey) فقط یک بار در پاسخ نمایش داده می‌شود. حتماً آن را در مکان امن (Secret Manager) ذخیره کنید.

مدیریت کلیدها

@@ -141,15 +145,16 @@ GET /apikeys/list POST /apikeys/delete/ -ورودی: public_key در آدرس +ورودی: public_key در آدرس خروجی: + ```json { "status": "ok" } ``` -کلید عمومی را در یو آر ال قرار دهید. +کلید عمومی را در یو آر ال قرار دهید. #### بروزرسانی کلید @@ -173,7 +178,7 @@ POST /apikeys/update/ > نمونه پاسخ -```json +```json { "key": { "createdAt": "2025-09-02T16:50:29.381869Z", @@ -191,7 +196,7 @@ POST /apikeys/update/

دسترسی ها

-سه دسترسی خواندن، معامله و برداشت تعریف شده است. +شش دسترسی خواندن، معامله، برداشت، واریز، دفتر آدرس و OTP تعریف شده است.

READ

@@ -234,7 +239,11 @@ POST /apikeys/update/ * `users/wallets/withdraws/list` * `users/wallets/deposit/bank` * `users/wallets/deposit/shetab` -* `withdraws/` +* `withdraws/ + +**امنیت** + +* `address_book` **معاملات تعهدی** @@ -247,10 +256,9 @@ POST /apikeys/update/ * `positions//edit-collateral/options` * `margin/predict/` -

Trade

کلید با این دسترسی، به ای پی آی هایی که برای ثبت و کنسل سفارشات و در کل کنترل -سفارشات استفاده می‌شوند، دسترسی دارد. +سفارشات استفاده می‌شوند، دسترسی دارد. با اختصاص این مجوز به یک کلید، دسترسی به ای پی آی های زیر به آن کلید داده می‌شود: @@ -271,7 +279,7 @@ POST /apikeys/update/

Withdraw

-کلید با این دسترسی، به ای پی آی های برداشت دسترسی دارد. +کلید با این دسترسی، به ای پی آی های برداشت دسترسی دارد. پیشنهاد می‌کنیم برای این کلید حتما آی پی مشخص کنید. با اختصاص این مجوز به یک کلید، دسترسی به این اند پوینت ها باز می‌شود: @@ -279,34 +287,116 @@ POST /apikeys/update/ * `users/wallets/withdraw` * `users/wallets/withdraw-confirm` * `users/wallets/withdraw-cancel` +* `security/emergency-cancel/get-code` +* `security/emergency-cancel/activate` + +

Deposit

+ +کلید با این دسترسی، به ای پی آی های مربوط به تولید آدرس واریز رمزارز دسترسی دارد. + +با اختصاص این مجوز به یک کلید، دسترسی به ای پی آی های زیر به آن کلید داده می‌شود: + +* `users/wallets/generate-address` + +

Address Book

+ +کلید با این دسترسی، به ای پی آی های تغییردهنده دفتر آدرس و حالت برداشت امن دسترسی دارد. + +با اختصاص این مجوز به یک کلید، دسترسی به ای پی آی های زیر به آن کلید داده می‌شود: + +* `address_book` در متد `POST` +* `address_book//delete` +* `address_book/whitelist/activate` +* `address_book/whitelist/deactivate` + +

OTP

+ +کلید با این دسترسی، می‌تواند برای سناریوهایی مثل دفتر آدرس یا کد آنتی‌فیشینگ، رمز یکبارمصرف درخواست کند. + +با اختصاص این مجوز به یک کلید، دسترسی به ای پی آی های زیر به آن کلید داده می‌شود: + +* `v2/otp/request`

استفاده از کلید API

برای استفاده از API باید سه هدر زیر در هر درخواست ارسال شوند: -| Header | توضیح | -|------------------------|----------------------------------------------------------------------| -| `Nobitex-Key` | کلید عمومی تولید شده توسط کاربر | -| `Nobitex-Signature` | امضای محاسبه‌شده با الگوریتم `Ed25519` | -| `Nobitex-Timestamp` | زمان جاری به ثانیه (Unix timestamp) در منطقه زمانی UTC | +| Header | توضیح | +| --------------------- | --------------------------------------------------------------------------------- | +| `Nobitex-Key` | کلید عمومی تولید شده توسط کاربر | +| `Nobitex-Signature` | امضای محاسبه‌شده با الگوریتم `Ed25519` | +| `Nobitex-Timestamp` | زمان جاری به ثانیه (Unix timestamp) در منطقه زمانی UTC |

نحوه محاسبه امضا (Signature)

امضا به صورت زیر محاسبه می‌شود: ```shell - signature = base64(Ed25519(timestamp + method + url + body)) + signature = urlsafe_base64(Ed25519(timestamp + method + full_path + raw_body)) ``` -- **timestamp**: عدد ثانیه‌ای (Unix time) بر اساس UTC -- **method**: متد HTTP درخواست (مانند `GET`, `POST`) -- **url**: مسیر کامل درخواست (endpoint) مانند `/market/orders/list?fromId=123` -- **body**: محتوای خام بدنه درخواست (برای متدهای `POST`، `PUT` و …) +- **timestamp**: عدد ثانیه‌ای (Unix time) بر اساس UTC +- **method**: متد HTTP درخواست (مانند `GET`, `POST`) +- **full_path**: خروجی کامل مسیر درخواست، شامل query string در صورت وجود، مانند `/market/orders/list?fromId=123` +- **raw_body**: محتوای خام بدنه درخواست دقیقاً به همان شکلی که ارسال می‌شود (برای متدهای `POST`، `PUT` و …) > توجه: مقدار `Nobitex-Key` همان کلید عمومی شماست و باید به صورت ثابت در هدر ارسال شود. +> توجه: اختلاف زمان `Nobitex-Timestamp` با زمان سرور باید حداکثر ۳۰ ثانیه باشد. + +

نمونه ساخت امضا

+ +فرض کنید می‌خواهید درخواست زیر را امضا کنید: + +- **timestamp**: `1714387200` +- **method**: `POST` +- **full_path**: `/market/orders/cancel-old` +- **body**: + +```json +{ + "order": 27032, + "status": "canceled" +} +``` + +در این حالت، رشته‌ای که باید با کلید خصوصی `Ed25519` امضا شود برابر است با: + +```text +1714387200POST/market/orders/cancel-old{"order": 27032, "status": "canceled"} +``` + +پس از امضای این رشته و تبدیل خروجی به `urlsafe base64`، مقدار حاصل را باید در هدر `Nobitex-Signature` قرار دهید. + +```python +import base64 +import json +from cryptography.hazmat.primitives.asymmetric.ed25519 import Ed25519PrivateKey + +timestamp = "1714387200" +method = "POST" +full_path = "/market/orders/cancel-old" +body_dict = { + "order": 27032, + "status": "canceled", +} +body = json.dumps(body_dict) +payload = f"{timestamp}{method}{full_path}{body}".encode() + +# این همان privateKey است که در پاسخ /apikeys/create برمی‌گردد +private_key_b64 = "" +private_key_bytes = base64.urlsafe_b64decode(private_key_b64) +private_key = Ed25519PrivateKey.from_private_bytes(private_key_bytes) + +signature = private_key.sign(payload) +signature_b64 = base64.urlsafe_b64encode(signature).decode() + +print("Nobitex-Timestamp:", timestamp) +print("Nobitex-Signature:", signature_b64) +``` + ```bash -curl -X POST "https://apiv2.nobitex.ir/orders/cancel-old" \ +curl -X POST "https://apiv2.nobitex.ir/market/orders/cancel-old" \ -H "Content-Type: application/json" \ -H "Nobitex-Key: " \ -H "Nobitex-Signature: " \ @@ -317,11 +407,9 @@ curl -X POST "https://apiv2.nobitex.ir/orders/cancel-old" \ }' ``` -

تنظیم User Agent

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

محدودیت‌ها

توجه داشته باشید، برای استفاده از APIها محدودیت هایی وجود دارد که در قسمت توضیحات هر کدام از APIها این موارد ذکر شده است. @@ -346,23 +434,22 @@ curl -X POST "https://apiv2.nobitex.ir/orders/cancel-old" \ مخزن گیت‌هاب مستندات نوبیتکس API مورد (issue) جدیدی را ایجاد نمایید و با ما در ارتباط باشید. دقت کنید که این کانال عمومی است و نباید در آن هیچ گونه اطلاعات حساس یا توکن یا سایر اطلاعات حساب خود را مطرح کنید. -

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

اگر برای اولین بار از API نوبیتکس یا سایر بازارهای رمزارز استفاده می‌کنید، برای شروع کار پیشنهاد می‌شود گام‌های زیر را طی کنید: * برای شروع کار با API پیشنهاد می‌شود که ابتدا در نوبیتکس -ثبت‌نام -نمایید و مراحل احراز هویت خود را حداقل تا سطح یک انجام دهید. + ثبت‌نام + نمایید و مراحل احراز هویت خود را حداقل تا سطح یک انجام دهید. * با مراجعه به پنل کاربری خود در نوبیتکس، از بخش پروفایل وارد -صفحه تنظیمات -شده و توکن خود را دریافت نمایید. دسترسی به این توکن به منزله دسترسی کامل به حساب شماست، در نتیجه در حفاظت آن دقت کامل داشته باشید. + صفحه تنظیمات + شده و توکن خود را دریافت نمایید. دسترسی به این توکن به منزله دسترسی کامل به حساب شماست، در نتیجه در حفاظت آن دقت کامل داشته باشید. * اگر با نرم‌افزار Postman آشنا هستید، می‌توانید برای تست فراخوانی APIهای اصلی نوبیتکس، از -کالکشن Postman نوبیتکس -استفاده کنید. لازم به توضیح است که این کالکشن تنها شامل برخی از APIهای نوبیتکس و کاربرد آن‌ها است و مرجع اصلی مستندات، همین صفحه است. + کالکشن Postman نوبیتکس + استفاده کنید. لازم به توضیح است که این کالکشن تنها شامل برخی از APIهای نوبیتکس و کاربرد آن‌ها است و مرجع اصلی مستندات، همین صفحه است. همین طور می‌توانید بنا به نیاز خود این موارد را نیز در ادامه در نظر بگیرید: * در صورت تمایل به دریافت دوره‌ای و خودکار توکن، می‌توانید از -API ورود - دریافت توکن -استفاده نمایید. + API ورود - دریافت توکن + استفاده نمایید. diff --git a/source/includes/_market_trade.md b/source/includes/_market_trade.md index d441aa3..db2079c 100644 --- a/source/includes/_market_trade.md +++ b/source/includes/_market_trade.md @@ -44,6 +44,10 @@ http POST https://apiv2.nobitex.ir/market/orders/add \ - **درخواست:**: `POST /market/orders/add` - **محدودیت فراخوانی:** 300 درخواست در هر ۱۰ دقیقه (محدودیت مشترک) + + ثبت سفارش الزاماً به معنی انجام معامله نیست و بسته به نوع و قیمت سفارش و وضعیت لحظه‌ای بازار ممکن است معامله انجام شود یا نشود. با درخواست «مشاهده وضعیت سفارش» می‌توانید از وضعیت سفارش خود مطلع شوید. سفارش‌ها پس از ثبت، پیش از ورود به دفتر معاملاتی و انجام معامله، مجدداً از نظر اعتبار مورد بررسی قرار گرفته و در صورت نامعتبر بودن، به وضعیت «رد شده» برده خواهند شد. به همین علت در صورتی که سفارش‌های شما ثبت می‌شود ولی بلافاصله به وضعیت «رد شده» تغییر حالت پیدا می‌کنند، پارامترهای ارسالی خود به ویژه مقدار و قیمت سفارش و موجودی حساب خود را دقیق‌تر بررسی نمایید. @@ -284,6 +288,10 @@ http POST https://apiv2.nobitex.ir/market/orders/status \ - **درخواست:** `POST /market/orders/status` - **محدودیت فراخوانی:** 300 درخواست در هر دقیقه + + ###پارامترهای ورودی: پارامتر | نوع | پیش‌فرض | توضیحات | نمونه @@ -369,6 +377,10 @@ http GET https://apiv2.nobitex.ir/market/orders/list \ - **محدودیت فراخوانی:** 30 درخواست در دقیقه - **صفحه بندی:** دارد (پیش فرض ۱۰۰) + + ### پارامترهای ورودی پارامتر | نوع | پیش‌فرض | توضیحات | نمونه ----------- | ---- |----------------------------------------|-----------------------------------------------------------------------------------------| ----- @@ -485,6 +497,10 @@ http POST https://apiv2.nobitex.ir/market/orders/update-status \ - **درخواست:** `POST /market/orders/update-status` - **محدودیت فراخوانی:** 90 درخواست در دقیقه + + ###پارامترهای ورودی پارامتر | نوع | پیش‌فرض | توضیحات | نمونه @@ -550,6 +566,10 @@ http POST https://apiv2.nobitex.ir/market/orders/cancel-old \ - **درخواست:** `POST /market/orders/cancel-old` - **محدودیت فراخوانی:** 30 درخواست در دقیقه + + ###پارامترهای ورودی | پارامتر | نوع | پیش‌فرض | توضیحات | نمونه | @@ -621,6 +641,10 @@ http GET https://apiv2.nobitex.ir/market/trades/list?srcCurrency=usdt&dstCurrenc - **محدودیت فراخوانی:** 30 درخواست در دقیقه - **صفحه بندی:** دارد (پیش فرض ۳۰) + + ### پارامترهای ورودی diff --git a/source/includes/_portfolio.md b/source/includes/_portfolio.md index 05a3ee4..9aa3430 100644 --- a/source/includes/_portfolio.md +++ b/source/includes/_portfolio.md @@ -100,6 +100,10 @@ Authorization: Token yourTOKENhereHEX0000000000 * **درخواست:** `POST users/portfolio/last-week-daily-profit` * **محدودیت فراخوانی:** 10 درخواست در 3 دقیقه + + ### نکات و ملاحظات: این API به صورت پیش فرض اطلاعات 7 روز گذشته را ارائه می دهد. برای دریافت اطلاعات ماهانه یا ۳۰ روز گذشته کافیست پارامتر monthly با مقدار true را به همراه این درخواست ارسال نمایید. @@ -185,6 +189,10 @@ Authorization: Token yourTOKENhereHEX0000000000 * **درخواست:** `POST users/portfolio/last-week-daily-total-profit` * **محدودیت فراخوانی:** 10 درخواست در 3 دقیقه + +

سود و زیان کل ماه گذشته

@@ -236,5 +244,8 @@ Authorization: Token yourTOKENhereHEX0000000000 * **درخواست:** `POST users/portfolio/last-month-total-profit` * **محدودیت فراخوانی:** 10 درخواست در 3 دقیقه + diff --git a/source/includes/_position.md b/source/includes/_position.md index 47d127e..cd28485 100644 --- a/source/includes/_position.md +++ b/source/includes/_position.md @@ -278,6 +278,10 @@ http GET https://apiv2.nobitex.ir/margin/v2/delegation-limit \ - **درخواست:**: `GET /margin/v2/delegation-limit` - **محدودیت فراخوانی:** ۱۲ درخواست در هر دقیقه + + ### پارامترهای ورودی @@ -376,6 +380,10 @@ http POST https://apiv2.nobitex.ir/margin/orders/add \ - **درخواست:**: `POST /margin/orders/add` - **محدودیت فراخوانی:** ۳۰۰ درخواست در هر ۱۰ دقیقه + + ### پارامترهای ورودی @@ -536,6 +544,10 @@ http GET https://apiv2.nobitex.ir/positions/list \ - **صفحه‌بندی:** دارد (پیش فرض ۵۰) + + ### پارامترهای ورودی | پارامتر | نوع | پیش‌فرض | توضیحات | نمونه | @@ -670,6 +682,10 @@ http GET https://apiv2.nobitex.ir/positions/128/status - **درخواست:**: `GET /positions/:positionId:/status` - **محدودیت فراخوانی:** ۱۰۰ درخواست در هر ۱۰ دقیقه (محدودیت مشترک) + + ### پارامترهای ورودی | پارامتر | نوع | پیش‌فرض | توضیحات | نمونه | @@ -731,6 +747,10 @@ http POST https://apiv2.nobitex.ir/positions/128/close \ - **درخواست:**: `POST /positions/:positionId:/close` - **محدودیت فراخوانی:** ۳۰۰ درخواست در هر ۱۰ دقیقه + + ### پارامترهای ورودی | پارامتر | نوع | پیش‌فرض | توضیحات | نمونه | @@ -865,6 +885,10 @@ http POST https://apiv2.nobitex.ir/positions/128/edit-collateral \ - **درخواست:**: `POST /positions/:positionId:/edit-collateral` - **محدودیت فراخوانی:** ۶۰ درخواست در هر دقیقه + + ### پارامترهای ورودی | پارامتر | نوع | پیش‌فرض | توضیحات | نمونه | diff --git a/source/includes/_security.md b/source/includes/_security.md index eea2c52..f3692f6 100644 --- a/source/includes/_security.md +++ b/source/includes/_security.md @@ -37,12 +37,12 @@ http POST https://apiv2.nobitex.ir/users/login-attempts \ ```shell curl 'https://apiv2.nobitex.ir/security/emergency-cancel/activate' \ - -X GET \ + -X POST \ -H "Authorization: Token yourTOKENhereHEX0000000000" ``` ```plaintext -http GET https://apiv2.nobitex.ir/security/emergency-cancel/activate \ +http POST https://apiv2.nobitex.ir/security/emergency-cancel/activate \ Authorization: Token yourTOKENhereHEX0000000000 ``` @@ -58,11 +58,14 @@ http GET https://apiv2.nobitex.ir/security/emergency-cancel/activate \ ``` -جهت فعالسازی امکان لغو اضطراریِ درخواست های برداشت از این درخواست استفاده نمائید. +جهت دریافت کد فعالسازی و فعالسازی امکان لغو اضطراریِ درخواست های برداشت از درخواست‌های زیر استفاده نمائید. پس از فعالسازی این امکان، پیامک و ایمیل ارسالی پس از ثبت درخواست برداشت، حاوی لینکی خواهد بود که شما میتوانید با استفاده از آن در صورتی که درخواست برداشت توسط شما ثبت نشده است، در کمترین زمان ممکن و بدون نیاز به لاگین، درخواست های برداشت خود را لغو نمایید. -- **درخواست:** `GET /security/emergency-cancel/activate` +- **درخواست دریافت کد:** `POST /security/emergency-cancel/get-code` +- **درخواست فعالسازی:** `POST /security/emergency-cancel/activate` + +در صورت استفاده از API Key برای این درخواست‌ها، دسترسی `WITHDRAW` روی کلید الزامی است. ### نکات و ملاحظات @@ -98,6 +101,10 @@ curl --location --request POST 'https://apiv2.nobitex.ir/security/anti-phishing' > برای دریافت رمزیکبارمصرف otpCode باید از API زیر با پارامترهای مشخص شده استفاده نمایید: + + ```shell curl -X POST 'https://apiv2.nobitex.ir/v2/otp/request' \ -H 'Authorization: Token yourTOKENhereHEX0000000000' \ @@ -162,7 +169,7 @@ otpCode | number | الزامی | کد یکبار مصرف ارسال شده ب ```shell curl --location --request GET 'https://apiv2.nobitex.ir/security/anti-phishing' \ ---header 'Authorization: Token yourTOKENhereHEX0000000000' +--header 'Authorization: Token yourTOKENhereHEX0000000000' ``` diff --git a/source/includes/_user_data.md b/source/includes/_user_data.md index 060b3e8..9b6534c 100644 --- a/source/includes/_user_data.md +++ b/source/includes/_user_data.md @@ -88,6 +88,10 @@ http POST https://apiv2.nobitex.ir/users/profile \ - **درخواست:** `GET /users/profile` + + ### پارامترهای ورودی برای دریافت پاسخ، کافیست توکن احراز هویت را ارسال نمایید @@ -120,6 +124,10 @@ http POST https://apiv2.nobitex.ir/users/wallets/generate-address \ - **درخواست:** `POST /users/wallets/generate-address` - **محدودیت فراخوانی:** ۳۰ درخواست در ساعت + + ### پارامترهای ورودی @@ -265,6 +273,10 @@ http GET https://apiv2.nobitex.ir/users/limitations - **درخواست:** `POST /users/limitations` + + ### پارامترهای ورودی - در این بخش به ورودی نیاز نیست. - توکن دریافتی از بخش لاگین باید در هدر ارسال شود. @@ -363,6 +375,10 @@ http GET https://apiv2.nobitex.ir/users/wallets/list \ - **درخواست:** `GET /users/wallets/list` - **محدودیت فراخوانی:** 20 درخواست در 2 دقیقه + + ### نکات و ملاحظات 1. کیف پول یک رمزارز در صورتی برای کاربر ایجاد می‌شود که کاربر سفارشی در بازار آن رمزارز ثبت کرده و یا آدرس واریز برای آن ایجاد کرده باشد. @@ -408,6 +424,10 @@ http GET https://apiv2.nobitex.ir/v2/wallets \ - **درخواست:** `GET /v2/wallets` - **محدودیت فراخوانی:** 15 درخواست در دقیقه + + ### پارامترهای ورودی پارامتر | نوع | پیش‌فرض | توضیحات | نمونه @@ -449,6 +469,10 @@ http POST https://apiv2.nobitex.ir/users/wallets/balance \ - **درخواست:** `POST /users/wallets/balance` - **محدودیت فراخوانی:** ۶۰ درخواست در ۲ دقیقه + + ### پارامترهای ورودی پارامتر | نوع | پیش‌فرض | توضیحات | نمونه @@ -505,6 +529,10 @@ http GET https://apiv2.nobitex.ir/users/wallets/transactions/list \ - **محدودیت فراخوانی:** ۶۰ درخواست در ۲ دقیقه - **صفحه بندی:** دارد (پیشفرض ۵۰) + + ### پارامترهای ورودی پارامتر | نوع | پیش‌فرض | توضیحات | نمونه @@ -562,6 +590,10 @@ http GET https://apiv2.nobitex.ir/users/transactions-history \ - **محدودیت فراخوانی:** ۶۰ درخواست در ساعت - **صفحه بندی:** دارد (پیشفرض ۵۰) + + ### پارامترهای ورودی | پارامتر | نوع | پیش‌فرض | توضیحات | نمونه | @@ -638,6 +670,10 @@ http GET https://apiv2.nobitex.ir/users/wallets/deposits/list \ - **صفحه بندی:** دارد (پیشفرض ۱۰برای ریال و ۲۰برای سایر) - **فیلترزمانی:** دارد + + ### پارامترهای ورودی پارامتر | نوع | پیش‌فرض | توضیحات | نمونه @@ -762,4 +798,3 @@ http DELETE https://apiv2.nobitex.ir/users/markets/favorite پارامتر | نوع | پیش‌فرض | توضیحات | نمونه ----------- | ---- | ------ |-----------------------------------| ----- market | string | الزامی | نماد بازار و یا All برای حذف همه | `All` or `BTCIRT` - diff --git a/source/includes/_withdraw_coin.md b/source/includes/_withdraw_coin.md index 91045f3..f58d9f4 100644 --- a/source/includes/_withdraw_coin.md +++ b/source/includes/_withdraw_coin.md @@ -47,6 +47,10 @@ http POST https://apiv2.nobitex.ir/users/wallets/withdraw \ * **درخواست:** `POST /users/wallets/withdraw` * **محدودیت فراخوانی:** 10 درخواست در 3 دقیقه + + ### پارامترهای ورودی | پارامتر | نوع | پیش‌فرض | توضیحات | نمونه | @@ -142,6 +146,10 @@ http POST https://apiv2.nobitex.ir/users/wallets/withdraw-confirm \ * **درخواست:** `POST /users/wallets/withdraw-confirm` * **محدودیت فراخوانی:** 30 درخواست در ساعت + + ### پارامترهای ورودی | پارامتر | نوع | پیش‌فرض | توضیحات | نمونه | @@ -195,10 +203,13 @@ http GET https://apiv2.nobitex.ir/withdraws/433 * **درخواست:** `GET /withdraws/WITHDRAW` * **محدودیت فراخوانی:** ۶۰ درخواست در ۲ دقیقه + + ### پارامترهای ورودی | پارامتر | نوع | پیش‌فرض | توضیحات | نمونه | |-------------|-----|---------|----------------------|-------| | WITHDRAW | int | الزامی | شناسه درخواست برداشت | 433 | - diff --git a/source/includes/_withdraw_list.md b/source/includes/_withdraw_list.md index 613863f..05154da 100644 --- a/source/includes/_withdraw_list.md +++ b/source/includes/_withdraw_list.md @@ -89,6 +89,10 @@ http GET https://apiv2.nobitex.ir/users/wallets/withdraws/list * **صفحه بندی:** دارد (پیش فرض 20) * **فیلترزمانی:** دارد + + ### پارامترهای ورودی | پارامتر | نوع | پیش‌فرض | توضیحات | نمونه | diff --git a/source/includes/internal/_batch_actions.md b/source/includes/internal/_batch_actions.md index 351e43f..da7dcde 100644 --- a/source/includes/internal/_batch_actions.md +++ b/source/includes/internal/_batch_actions.md @@ -158,6 +158,10 @@ Content-Type: application/json * **محدودیت فراخوانی:** 300 درخواست در 10 دقیقه
300 سفارش در 10 دقیقه ([مشترک با ثبت سفارش تکی](/#order_ratelimit)) + + ### پارامترهای ورودی | پارامتر | نوع | پیش‌فرض | توضیحات | نمونه | @@ -261,6 +265,10 @@ Content-Type: application/json * **محدودیت فراخوانی:** 10 درخواست در هر دقیقه * حداکثر 20 سفارش در هر درخواست + + ### پارامترهای ورودی | پارامتر | نوع | پیش‌فرض | توضیحات | نمونه |