Skip to content

Commit

Permalink
add changes to orders list API's pagination (#276)
Browse files Browse the repository at this point in the history
* add changes to orders list API's pagination

* fix number

* fix text

* fix text
  • Loading branch information
FarzanehRst authored Nov 19, 2024
1 parent 4ea61f2 commit d1c014f
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions source/includes/_market_trade.md
Original file line number Diff line number Diff line change
Expand Up @@ -367,7 +367,7 @@ http GET https://api.nobitex.ir/market/orders/list \

- **درخواست:** `GET /market/orders/list`
- **محدودیت فراخوانی:** 30 درخواست در دقیقه
- **<a href="/#pagination">صفحه بندی:</a>** دارد (پیش فرض ۱۰۰۰)
- **<a href="/#pagination">صفحه بندی:</a>** دارد (پیش فرض ۱۰۰)

### پارامترهای ورودی
پارامتر | نوع | پیش‌فرض | توضیحات | نمونه
Expand Down Expand Up @@ -430,8 +430,8 @@ created_at | datetime | تاریخ ایجاد سفارش | `2020-07-15T11:32:38.
averagePrice | monetary | میانگین قیمت اجرا شده از سفارش | `2899500000`

### نکات و ملاحظات
1. در پاسخ حداکثر اطلاعات هزار سفارش بازگردانده می‌شود. با استفاده از پارامترهای ورودی می‌توانید تعداد محدودتری از سفارش‌های خود را دریافت کنید. همچنین پیشنهاد می‌شود که در صورتی که تعداد زیادی سفارش باز دارید، شناسه آن‌ها را در زمان ثبت سفارش دریافت و ذخیره نمایید و به صورت مستقل با استفاده از درخواست «مشاهده وضعیت سفارش» اطلاعات هر یک را بنا به نیاز به‌روز کنید. همچنین برای اطلاع از معاملات انجام شده خود می‌توانید از درخواست [فهرست معاملات کاربر](/#1cf6f6c643) استفاده نمایید.
2. منظور از وضعیت Done سفارشی است که به صورت صد در صد اجرا شده باشد. ممکن است سفارش شما به تدریج اجرا شود، و در این حالت وضعیت آن کماکان Active می‌ماند. از فیلد matchedAmount برای تشخیص وضعیت اجرا و پر شدن سفارش استفاده کنید. همچنین ممکن است سفارش شما قبل از اجرای کامل، به دلیل درخواست «لغو سفارش» یا کمبود موجودی یا تغییر شدید قیمت بازار (در سفارش‌های مارکت) لغو شود که در این حالت وضعیت آن Canceled خواهد بود، به این معنی که به صورت صد در صد اجرا نشده است ولی می‌تواند مقدار matchedAmount آن بزرگ‌تر از صفر باشد.
1. در پاسخ به صورت پیش‌فرض اطلاعات ۱۰۰ سفارش بازگردانده می‌شود که با استفاده از پارامترهای ورودی می‌توانید تعداد متفاوتی از سفارش‌های خود را، تا حداکثر ۱۰۰۰ سفارش، دریافت کنید. در صورتی‌که میخواهید تعداد بیشتری از سفارش‌ها و یا سفارش‌های گذشته را دریافت کنید می‌توانید از پارامتر‌های page یا fromId استفاده کنید. توجه کنید که **استفاده‌ی همزمان از این دو پارامتر ممکن نیست** و در صورت ارسال پارامتر fromId یک صفحه از سفارش‌ها به تعداد مشخص بازگردانده می‌شود، که این تعداد با ارسال پارامتر pageSize قابل تنظیم است. همچنین پیشنهاد می‌شود که در صورتی که تعداد زیادی سفارش باز دارید، شناسه آن‌ها را در زمان ثبت سفارش دریافت و ذخیره نمایید و به صورت مستقل با استفاده از درخواست «مشاهده وضعیت سفارش» اطلاعات هر یک را بنا به نیاز به‌روز کنید. همچنین برای اطلاع از معاملات انجام شده خود می‌توانید از درخواست [فهرست معاملات کاربر](/#1cf6f6c643) استفاده نمایید.
2. منظور از وضعیت Done سفارشی است که به صورت صد در صد اجرا شده باشد. ممکن است سفارش شما به تدریج اجرا شود، و در این حالت وضعیت آن کماکان Active می‌ماند. از فیلد matchedAmount برای تشخیص وضعیت اجرا و پر شدن سفارش استفاده کنید. همچنین ممکن است سفارش شما قبل از اجرای کامل، به دلیل درخواست «لغو سفارش» یا کمبود موجودی یا تغییر شدید قیمت بازار (در سفارش‌های مارکت) لغو شود که در این حالت وضعیت آن Canceled خواهد بود، به این معنی که به صورت صد در صد اجرا نشده است ولی می‌تواند مقدار matchedAmount آن بزرگ‌تر از صفر باشد.
3. این API متناظر مواردی مانند <a href="https://binance-docs.github.io/apidocs/spot/en/#current-open-orders-user_data" rel="nofollow" target="_blank">Current Open Orders</a> و <a href="https://binance-docs.github.io/apidocs/spot/en/#all-orders-user_data" rel="nofollow" target="_blank">All Orders</a> در اکسچنج بایننس است.


Expand Down

0 comments on commit d1c014f

Please sign in to comment.