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

👋 مقدمه

با استفاده از Websocket API بیت‌پین، می‌توانید به آپدیت‌های بلادرنگ دسترسی پیدا کنید. این آپدیت‌ها شامل اطلاعات بازار، وضعیت سفارشات و معاملات کاربر است. تمام اطلاعاتی که از طریق REST API قابل دسترسی هستند، در Websocket API نیز موجود است. اما تفاوت اصلی در این است که Websocket به‌صورت بلادرنگ عمل می‌کند و تغییرات را بلافاصله به شما ارسال می‌کند.

با استفاده از وب‌سوکت می‌توانید به تعدادی از آپدیت‌ها و تغییرات به شکل نزدیک به زمان‌حقیقی (real-time) دسترسی داشته باشید. تمام این اطلاعات از طریق REST API بیت‌پین نیز قابل دسترسی است. به طور کلی وب‌سوکت آپدیت‌ها را در صورتی که تغییر رخ داده باشد ارسال می‌کند. به همین دلیل، در صورت لزوم می‌توانید وضعیت اولیه را از REST API و سپس آپدیت‌ها را از وب‌سوکت دریافت کنید.

🌐 Base URL

wss://ws.bitpin.ir

🔑 نکات کلیدی

اطلاعیه
  • برای اتصال به وب‌سوکت می‌توانید از هر یک از کلاینت‌های متداول استفاده کنید.
  • انواع مختلف پیام‌هایی که از طریق وب‌سوکت ارسال می‌شود، توضیح داده شده است. نیازی به ایجاد اتصال جدید برای هر بخش نیست. پیام‌های ارسال شده در وب‌سوکت دارای یک کلید event هستند که نوع پیام را مشخص می‌کند.
  • در صورتی که اتصال، به هر دلیلی، بسته شود، لازم است پیش از تلاش مجدد برای اتصال حداقل ۱۵ ثانیه صبر کنید.
  • توصیه می‌شود در صورت مشاهده‌ی نرخ بالای بسته شدن، وقفه‌ی بین تلاش‌های مجدد را به شکل پلکانی افزایش دهید.
  • در صورت استفاده نامتعارف، درخواست‌دهنده با محدودیت رو به رو خواهد شد.

🔄 مزایای استفاده از Websocket

  • سرعت بالا: به دلیل بلادرنگ بودن، وب‌سوکت به شما اجازه می‌دهد تا تغییرات بازار و سفارشات را سریع‌تر از REST API دریافت کنید.
  • بهینه‌سازی ترافیک: با استفاده از یک اتصال پایدار، حجم داده‌های ارسال شده کاهش می‌یابد.
  • استفاده آسان: می‌توانید از هر کلاینتی که از Websocket پشتیبانی می‌کند استفاده کنید.