Merge pull request #252 from nobitex/orders-list

fix ratelimits and text
nobitex · Sep 17, 2024 · d8c1bd2 · d8c1bd2
2 parents 658e12b + 4f4289d
commit d8c1bd2
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 13 deletions.
diff --git a/source/includes/_address_book.md b/source/includes/_address_book.md
@@ -196,7 +196,7 @@ https POST https://api.nobitex.ir/address_book/whitelist/activate
 }
 ```
 
-- **درخواست:**: `POST /address_book/address_book/whitelist/activate`
+- **درخواست:**: `POST /address_book/whitelist/activate`
 - **محدودیت فراخوانی:** 6 درخواست در هر دقیقه
 
 ## غیرفعال کردن برداشت امن
@@ -221,7 +221,7 @@ https POST https://api.nobitex.ir/address_book/whitelist/deactivate
 }
 ```
 
-- **درخواست:**: `POST /address_book/address_book/whitelist/deactivate`
+- **درخواست:**: `POST /address_book/whitelist/deactivate`
 - **محدودیت فراخوانی:** 6 درخواست در هر دقیقه
 
 ### پارامترهای ورودی

diff --git a/source/includes/_general_notes.md b/source/includes/_general_notes.md
@@ -88,7 +88,7 @@
 به خصوص در هنگام دریافت توکن از API لاگین، علاوه بر سایر پارامترها، رمز یک‌بار مصرف خود را نیز در هدرهای درخواست به این صورت ارسال نمایید:
 `X-TOTP: 123456`.
 
-## محدودیت‌های فراخوانی API
+<h2 id="ratelimits"> محدودیت‌های فراخوانی API</h2>
 برخی از APIهای نوبیتکس دارای محدودیت تعداد فراخوانی در هر بازه‌ی زمانی هستند. با این حال اگر شما به صورت معمولی و مشابه
 استفاده‌ی متداول کاربران از API استفاده کنید، با این محدودیت‌ها مواجه نخواهید شد. محدودیت‌ها به ازای هر API مستقلا محاسبه
 و اعمال می‌شوند. محدودیت‌ها معمولا بر اساس آدرس IP درخواست دهنده و در موارد هم بر اساس کاربر (توکن) درخواست دهنده می‌باشند.
@@ -100,5 +100,12 @@
 صورت مداوم به محدودیتی برای یک API برخورد می‌کنید و فکر می‌کنید که بهتر است تعداد فراخوانی مجاز آن API افزایش یابد، حتما با
 ایجاد یک مورد در گیت‌هاب ([لینک ایجاد مورد](https://github.com/nobitex/docs-api/issues/new)) مسئله را با ما مطرح نمایید.
 
+<h3 id="order_ratelimit">محدودیت مشترک APIهای سفارش‌گذاری</h3>
+توجه داشته باشید که تمامی API‌های مربوط به ثبت سفارش دارای محدودیت مشترک روی تعداد سفارش‌هایی که ثبت می‌شوند هستند. برای مثال، اگر همزمان هم در بازار اسپات و هم در بازار تعهدی سفارش ثبت می‌کنید، محدودیت فراخوانی شامل مجموع سفارش‌های ثبت شده در این دو بازار می‌شود.
+
+مقدار محدودیت مشترک: ۳۰۰ درخواست در ۱۰ دقیقه
+
+
+
 ## حالت متداول و Pro
 در برخی از درخواست‌ها جهت حفاظت بهتر از کاربران، برخی محدودیت‌ها اعمال می‌شود. در چنین مواردی در بخش ملاحظات این محدودیت‌ها توضیح داده شده و در انتهای آن عبارت «غیرفعال در حالت Pro» ذکر شده است. با ارائه پارامتر `pro` به مقدار `yes` به عنوان ورودی، این محدودیت برای آن درخواست غیرفعال می‌شود. با این حال دقت کنید که محدودیت‌های حالت متداول برای جلوگیری از حالت‌های خاص و اشتباهات رایج تعبیه شده است و تنها در صورت نیاز و آگاهی از تبعات احتمالی آن، اقدام به فعال‌سازی حالت Pro نمایید.
diff --git a/source/includes/_market_trade.md b/source/includes/_market_trade.md
@@ -42,7 +42,7 @@ http POST https://api.nobitex.ir/market/orders/add \
 برای ثبت سفارش معامله در بازار نوبیتکس از این درخواست استفاده نمایید.
 
 - **درخواست:**: `POST /market/orders/add`
-- **محدودیت فراخوانی:** 300 درخواست در هر ۱۰ دقیقه
+- **محدودیت فراخوانی:** 300 درخواست در هر ۱۰ دقیقه (<a href="#order_ratelimit">محدودیت مشترک</a>)
 
 ثبت سفارش الزاماً به معنی انجام معامله نیست و بسته به نوع و قیمت سفارش و وضعیت لحظه‌ای بازار ممکن است معامله انجام شود یا نشود. با درخواست «مشاهده وضعیت سفارش» می‌توانید از وضعیت سفارش خود مطلع شوید.
 
@@ -281,7 +281,7 @@ http POST https://api.nobitex.ir/market/orders/status \
 برای دریافت وضعیت سفارش از این نوع درخواست استفاده نمایید:
 
 - **درخواست:** `POST /market/orders/status`
-- **محدودیت فراخوانی:** 60 درخواست در هر دقیقه
+- **محدودیت فراخوانی:** 300 درخواست در هر دقیقه
 
 ###پارامترهای ورودی:
 
@@ -398,7 +398,7 @@ order | string  | متغیر براساس پارامترهای `fromId` و `type
 * در صورتیکه پارامتر ترتیب ارسال سفارشات در درخواست ارسال نشود:
   * اگر پارامتر fromId در درخواست ارسال شده باشد سفارش‌ها در پاسخ براساس شناسه‌ی سفارش به صورت نزولی مرتب می‌شوند.
   * اگر پارامتر نوع سفارش ارسال نشده باشد، سفارش‌ها در پاسخ به ترتیب زمان ایجاد سفارش به صورت نزولی بازگردانده می‌شوند.
-  * اگر نوع سفارش با مقدار `خرید` تعیین شده باشد سفارش‌ها به‌ترتیب قیمت به صورت نزولی و اگر نوع سفارش با مقدار `فروش` تعیین شده باشد سفارش‌هاس به ترتیب قیمت به صورت صعودی بازگردانده می‌شوند.
+  * اگر نوع سفارش با مقدار `خرید` تعیین شده باشد سفارش‌ها به ترتیب قیمت به صورت نزولی و اگر نوع سفارش با مقدار `فروش` تعیین شده باشد سفارش‌ها به ترتیب قیمت به صورت صعودی بازگردانده می‌شوند.
 
 ### پارامترهای پاسخ
 پارامتر | نوع | توضیحات | نمونه
@@ -461,7 +461,7 @@ http POST https://api.nobitex.ir/market/orders/update-status \
 برای تغییر وضعیت یک سفارش (لغو یا فعال‌سازی) از این نوع درخواست استفاده نمایید:
 
 - **درخواست:** `POST /market/orders/update-status`
-- **محدودیت فراخوانی:** 60 درخواست در دقیقه
+- **محدودیت فراخوانی:** 90 درخواست در دقیقه
 
 ###پارامترهای ورودی
 
@@ -478,7 +478,7 @@ status        | string        |  الزامی  |    وضعیت جدید   | `can
 2. اگر هر دو پارامتر ‍`order` و `clientOrderId`  ارسال شوند، اولویت با `id` است.
 3. `clientOrderId` فقط در میان سفارشات open/active/inactive جستجو میشود.
 4. `clientOrderId` .در حالت آزمایشی است و ممکن است در آینده تغییر کند
-5. مقدار status میتواند از 'new' به 'active' و یا از 'active'/'inactive' به 'cancel' تغییر کند.
+5. مقدار status میتواند از 'new' به 'active' و یا از 'active'/'inactive' به 'canceled' تغییر کند.
 در غیر اینصورت، درخواست رد میشود.
 6. در صورتی که سفارش درخواست شده جزئی از یک سفارش OCO انجام نشده باشد، هر دو سفارش مرتبط لغو خواهند شد.
 
@@ -596,7 +596,7 @@ http GET https://api.nobitex.ir/market/trades/list?srcCurrency=usdt&dstCurrency=
 برای دریافت فهرست معاملات ۳ روز اخیر خود، از این درخواست استفاده نمایید.
 
 - **درخواست:** `GET /market/trades/list`
-- **محدودیت فراخوانی:** 20 درخواست در دقیقه
+- **محدودیت فراخوانی:** 30 درخواست در دقیقه
 - **<a href="/#pagination">صفحه بندی:</a>** دارد (پیش فرض ۳۰)
 
 

diff --git a/source/includes/_position.md b/source/includes/_position.md
@@ -330,7 +330,7 @@ http POST https://api.nobitex.ir/margin/orders/add \
 برای درج سفارش در بازار تعهدی از این درخواست استفاده نمایید.
 
 - **درخواست:**: `POST /margin/orders/add`
-- **محدودیت فراخوانی:** ۱۰۰ درخواست در هر ۱۰ دقیقه
+- **محدودیت فراخوانی:** ۳۰۰ درخواست در هر ۱۰ دقیقه
 
 
 ### پارامترهای ورودی
@@ -624,7 +624,7 @@ http GET https://api.nobitex.ir/positions/128/status
 برای مشاهده وضعیت یک موقعیت از این درخواست استفاده کنید.
 
 - **درخواست:**: `GET /positions/:positionId:/status`
-- **محدودیت فراخوانی:** ۱۰۰ درخواست در هر ۱۰ دقیقه
+- **محدودیت فراخوانی:** ۱۰۰ درخواست در هر ۱۰ دقیقه (<a href="#order_ratelimit">محدودیت مشترک</a>)
 
 ### پارامترهای ورودی
 
@@ -685,7 +685,7 @@ http POST https://api.nobitex.ir/positions/128/close \
 به عبارتی با خرید تعهد موقعیت فروش یا فروش تعهد موقعیت خرید موقعیت شما قابل بسته شدن خواهد شد.
 
 - **درخواست:**: `POST /positions/:positionId:/close`
-- **محدودیت فراخوانی:** ۳۰۰ درخواست در هر دقیقه
+- **محدودیت فراخوانی:** ۳۰۰ درخواست در هر ۱۰ دقیقه
 
 ### پارامترهای ورودی
 

diff --git a/source/includes/internal/_batch_actions.md b/source/includes/internal/_batch_actions.md
@@ -156,7 +156,7 @@ Content-Type: application/json
 
 * **درخواست:** `POST /market/orders/batch-add`
 * **محدودیت فراخوانی:** 300 درخواست در 10 دقیقه
-<br/>300 سفارش در 10 دقیقه (مشترک با ثبت سفارش تکی)
+<br/>300 سفارش در 10 دقیقه ([مشترک با ثبت سفارش تکی](/#order_ratelimit))