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

Welcome to the Bitpin API documentation

اینجا جاییه که شما به عنوان یه توسعه‌دهنده، به تمامی ابزارها و اطلاعات لازم برای کار با API بیت‌پین دسترسی پیدا می‌کنید.
به کمک این API می‌تونید به داده‌های بازارها، قیمت‌ها و سایر عملیات‌های مالی دسترسی داشته باشید.

🌐 Base URL​

تمام درخواست‌های API باید به یکی از این آدرس‌ها ارسال بشه:

  • https://api.bitpin.ir
  • https://api.bitpin.org
اطلاعیه

توجه داشته باش که همیشه از آدرس درست استفاده کنی تا مطمئن بشی که اطلاعات صحیح و به‌روز دریافت می‌کنی.

⏱ Rate Limit​

حداکثر نرخ درخواست 300 درخواست در دقیقه به ازای هر IP است. این مقدار برای اکثر مسیرهای API صدق می‌کنه، ولی اگه جایی نرخ متفاوتی باشه، توی مستندات مربوط به اون بخش ذکر شده.

🔑 Authentication​

برای دسترسی به بخش‌هایی از API که نیاز به احراز هویت دارن، باید از توکن احراز هویت استفاده کنی.
توکن باید به این شکل در هدر درخواست HTTP قرار بگیره:

curl -X GET "https://api.bitpin.ir/api/v1/market/currencies" \  
     -H "Authorization: Bearer YOUR_AUTH_TOKEN" \  
     -H "Content-Type: application/json"

💬 Response​

پاسخ‌های API بیت‌پین همیشه به صورت JSON برمی‌گردن. یه نمونه از پاسخ موفق رو می‌بینی:

[  
  {  
    "currency": "IRT",  
    "name": "Toman",  
    "tradable": true,  
    "precision": "0"  
  },  
  {  
    "currency": "VTHO",  
    "name": "VeThor Token",  
    "tradable": true,  
    "precision": "0"  
  }  
]

Additional Notes​

  • Errors: اگه خطایی پیش بیاد، API یه پیام خطا و کد HTTP برمی‌گردونه. برای اطلاعات بیشتر به بخش مدیریت خطا مراجعه کن.
  • Security: حتماً مطمئن شو که توکن احراز هویتت رو امن نگه داری و به شخص ثالثی فاش نکنی.
  • Versioning: همیشه از نسخه درست API استفاده کن. نسخه API تو مسیر درخواست مشخص میشه (مثال: /v1/).