دریافت لیست سفارشات

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

🔗 Endpoint

GET /api/v1/odr/orders/

⏱ Rate Limit

اطلاعیه

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

📨 Request

curl --location --request GET 'https://api.bitpin.ir/api/v1/odr/orders/' \  
--header 'Authorization: Bearer eyJ0eXAiOiJ...M9B3NcH2F_fFKn45njGgoStttMsL4'  

🛠 Request Params

Parameter	Description	Type	Required	Example
symbol	نام بازار (مثل BTC_IRT)	String	خیر	BTC_IRT
side	نوع سفارش (خرید: buy یا فروش: sell)	Array[String]	خیر	buy,sell
state	وضعیت سفارش (initial، active، closed)	Array[String]	خیر	active,closed
type	نوع سفارش (limit، market، stop_limit، oco)	Array[String]	خیر	limit،market
identifier	شناسه خاص سفارش برای پیگیری یا جلوگیری از ثبت تکراری	String	خیر	abc123
start	سفارش‌هایی که بعد از این زمان ساخته شده‌اند رو نمایش می‌ده	Date	خیر	2024-07-15
end	سفارش‌هایی که قبل از این زمان ساخته شده‌اند رو نمایش می‌ده	Date	خیر	2024-07-15
ids_in	لیستی از شناسه‌های سفارش‌ها که می‌خوای نمایش داده بشن	Array[String]	خیر	1,2,3
identifiers_in	لیستی از شناسه‌های خاص سفارش‌ها برای فیلتر کردن نتایج	Array[String]	خیر	xyz1,xyz2
offset	سفارش‌هایی که شناسه‌شون کمتر از این مقداره رو نمایش بده	Integer	خیر	608612655
limit	حداکثر تعداد سفارش‌های دریافتی (حداکثر: 100)	Integer	خیر	50

💬 Success Response

[  
    {  
        "id": 1,  
        "symbol": "USDT_IRT",  
        "type": "limit",  
        "side": "buy",  
        "base_amount": "0.02",  
        "quote_amount": "1000",  
        "price": "50000",  
        "stop_price": null,  
        "oco_target_price": null,  
        "identifier": "716848bc-3f15-4b28-b113-0ce8dc621eff",  
        "state": "active",  
        "created_at": "2024-06-15T10:00:00.000000+03:30",  
        "closed_at": null,  
        "dealed_base_amount": "0",  
        "dealed_quote_amount": "0",  
        "req_to_cancel": false,  
        "commission": "0.5"  
    }  
]  

📝 Response Keys

• symbol: نام بازار که با _ جدا شده (مثل BTC_IRT).
• type: نوع سفارش که شامل یکی از موارد limit، market، stop_limit، oco می‌شه.
• side: نوع عملیات سفارش: buy برای خرید و sell برای فروش.
• base_amount: مقدار رمزارز پایه معامله شده (cryptocurrency) مثلاً در بازار بیت‌کوین به تومان، اگه 0.001 بیت‌کوین خریداری کردی، این مقدار برابر "0.001" می‌شه.
• quote_amount: مقدار ارز مبادله‌ای معامله شده (USDT or IRT) مثلاً در بازار بیت‌کوین به تومان، اگه سفارشی به ارزش یک میلیارد تومان داشته باشی، این مقدار برابر "1000000000" می‌شه.
• price: قیمت سفارش. در سفارش‌های limit و stop_limit و oco.
• stop_price: قیمت فعال‌سازی سفارش در سفارش‌های stop_limit و oco.
• oco_target_price: قیمت هدف در سفارش‌های oco.
• identifier: شناسه خاص سفارش که برای جلوگیری از ثبت سفارش‌های تکراری و پیگیری استفاده می‌شه.
• state: وضعیت سفارش که می‌تونه یکی از حالت‌های initial، active، closed باشه.
• req_to_cancel: اگه کاربر درخواست لغو سفارش رو ثبت کرده باشه، این مقدار true می‌شه.
• created_at: زمان ثبت سفارش به صورت timezone aware.
• closed_at: زمان بسته شدن سفارش به صورت timezone aware.
• dealed_base_amount: مقدار رمزارز پایه معامله شده در طول سفارش. این مقدار با تکمیل سفارش افزایش پیدا می‌کنه.
• dealed_quote_amount: مقدار ارز مبادله‌ای معامله شده در طول سفارش.
• commission: مقدار کارمزدی که در طول اجرای سفارش پرداخت شده.

Additional Notes

🌍 با استفاده از این API، می‌تونی به سادگی تمام سفارشاتت رو مدیریت کنی و به تفصیل بررسی کنی. این امر بهت امکان می‌ده تا به راحتی تاریخچه سفارشاتت رو مرور و آنالیز کنی و بر اساس داده‌ها، تصمیمات بهتری بگیری.