پرش به مطلب اصلی

ثبت سفارش

👋 Introduction​

با استفاده از این API، می‌تونی یه سفارش جدید ثبت کنی. این سفارش می‌تونه یکی از انواع سفارش‌های limit، market، stop_limit یا oco باشه.
همه‌ی درخواست‌های این بخش نیازمند ارایه توکن احراز هویت هستن. بنابراین، حتماً مطمئن شو که توکن احراز هویتت به‌درستی توی هدر درخواست قرار گرفته باشه. 🎫

🔗 Endpoint​

POST /api/v1/odr/orders/

⏱ Rate Limit​

اطلاعیه

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

📨 Request​

curl --location --request POST 'https://api.bitpin.ir/api/v1/odr/orders/' \  
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \  
--header 'Content-Type: application/json' \  
--data '{  
    "symbol": "BTC_IRT",  
    "type": "limit",  
    "side": "buy",  
    "base_amount": "0.01",  
    "quote_amount": "1000000",  
    "price": "100000000",  
    "stop_price": null,  
    "oco_target_price": null,  
    "identifier": "unique_order_id"  
}'

💬 Success Response​

{  
    "id": 535179385,  
    "symbol": "PIXFI_IRT",  
    "type": "limit",  
    "side": "sell",  
    "price": "1956",  
    "stop_price": null,  
    "oco_target_price": null,  
    "base_amount": "63.0",  
    "quote_amount": "123228",  
    "identifier": null,  
    "state": "active",  
    "closed_at": null,  
    "created_at": "2024-07-29T14:07:34.176795+03:30",  
    "dealed_base_amount": "0",  
    "dealed_quote_amount": "0",  
    "req_to_cancel": false,  
    "commission": "1000"  
}

🛠 Request Params​

ParameterDescriptionTypeRequired
symbolنام بازار (مثل BTC_IRT)Stringبله
typeنوع سفارش (limit، market، stop_limit، oco)Stringبله
sideساید سفارش (buy یا sell)Stringبله
base_amountمقدار معامله بر اساس ارز پایهDecimalبله
quote_amountمقدار معامله بر اساس ارز مبادله‌ایDecimalخیر
priceقیمت هدف معامله (فقط برای سفارش‌های limit و oco)Decimalخیر
stop_priceقیمت شرط شروع معامله (فقط برای سفارش‌های stop_limit و oco)Decimalخیر
oco_target_priceقیمت هدف در سفارش‌های oco.Decimalخیر
identifierشناسه خاص سفارش برای پیگیری و جلوگیری از ثبت تکراریStringخیر

Additional Notes​

  • حتماً مطمئن شو که symbol و type رو به‌درستی تنظیم کردی، چون این دو پارامتر نقش مهمی تو نوع سفارش و بازار معاملاتی دارن.
  • اگه از سفارش‌های oco استفاده می‌کنی، باید پارامترهای price و stop_price و oco_target_price رو دقیق تنظیم کنی تا سفارش به‌درستی اجرا بشه.
  • identifier یه شناسه خاصه که می‌تونی برای جلوگیری از ثبت سفارش‌های تکراری و پیگیریشون استفاده کنی. این پارامتر به‌ویژه زمانی که سیستم‌های خودکار برای ثبت سفارش استفاده می‌شن، خیلی مفیده.