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

Request

👋 Introduction​

تو این بخش، توضیحات کلی درباره‌ی ساختار درخواست‌ها و نحوه‌ی ارسالشون به API بیت‌پین رو پیدا می‌کنی. درخواست‌ها معمولاً شامل URL Endpoint، پارامترهای ورودی و هدرهای احراز هویت هستن.

🛠 Request Structure​

پارامترها می‌تونن به دو روش ارسال بشن:

  • Query String: برای درخواست‌های GET
  • Request Body: برای درخواست‌های POST

پارامترها بسته به Endpoint متفاوت هستن و برای هر Endpoint به‌طور خاص توی مستندات اون بخش توضیح داده شدن. برای مثال:

💡 Example​

توی مثال زیر، یک درخواست POST برای ثبت سفارش جدید ارسال می‌شه.

POST /v1/odr/orders  

curl --location --request POST 'https://api.bitpin.ir/api/v1/odr/orders' \  
--header 'Authorization: Bearer YOUR_AUTH_TOKEN' \  
--header 'Content-Type: application/json' \  
--data '{
    "symbol": "USDT_IRT",
    "type": "limit",
    "side": "buy",
    "price": 50000,
    "base_amount" : 100
}'

🛠 Request Params​

ParameterDescriptionRequired
symbolنام بازار (مثل USDT_IRT)بله
typeنوع سفارش (limit یا market)بله
sideخرید یا فروشبله
priceقیمت سفارشبله
base_amountمقدار ارز پایه برای سفارشبله
نکته

برای هر Endpoint، ممکنه پارامترهای مختلفی استفاده بشه. همیشه به مستندات Endpoint مربوطه سر بزن.