دریافت سفارش با شناسه

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

اطلاعیه

برای استفاده از این API، حتماً باید شناسه سفارش (order ID) یا شناسه خاص (identifier) ثبت‌شده برای سفارش رو توی درخواستت ارسال کنی.

اطلاعیه

می‌تونی چندین شناسه سفارش یا شناسه خاص رو با , از هم جدا کنی و توی URL ارسال کنی تا وضعیت چندین سفارش رو به‌صورت همزمان بررسی کنی.

🔗 Endpoint

GET /api/v1/odr/orders/{order_id}/

⏱ Rate Limit

اطلاعیه

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

هشدار

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

📨 Request

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

💬 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: مقدار کارمزدی که در طول اجرای سفارش پرداخت شده.