الانتقال إلى المحتوى الرئيسي

Documentation Index

Fetch the complete documentation index at: https://docs.benzinga.com/llms.txt

Use this file to discover all available pages before exploring further.

مرحبًا بك في توثيق واجهة برمجة التطبيقات API للويب سوكيت من Benzinga. سيساعدك هذا الدليل على البدء في الوصول إلى تدفقات بيانات Benzinga اللحظية، مما يتيح لك الاشتراك في تحديثات مستمرة لبيانات الأسواق المالية، بما في ذلك أسعار السوق اللحظية، والصفقات، والأخبار، وغير ذلك من الرؤى الأساسية الأخرى.

​
نقطة نهاية ويب سوكيت

يمكن إقامة جميع اتصالات ويب سوكيت عبر نقطة النهاية التالية: 
wss://api.benzinga.com

​
المصادقة

تتطلّب واجهة برمجة التطبيقات API الخاصة بـ Benzinga عبر ويب سوكيت مصادقة بنظام Bearer. عند بدء اتصال ويب سوكيت، ضمِّن رمز الوصول الخاص بواجهة برمجة التطبيقات API في عنوان URL الاتصال كمعامل استعلام بالصيغة التالية: يجب عليك تضمين رمز الوصول الخاص بواجهة برمجة التطبيقات API في معامل الاستعلام token بالصيغة token: <token>. راجع صفحة المصادقة لمزيد من المعلومات حول الحصول على رمز الوصول لواجهة برمجة التطبيقات API وإدارته.

​
الاشتراك في التدفقات

بعد إنشاء الاتصال، يمكنك الاشتراك في تدفقات بيانات معينة استنادًا إلى احتياجاتك، مثل أسعار الأسهم، بيانات التداول، أو تحديثات الأخبار. يتطلب كل اشتراك مُعرّفًا فريدًا ومعلمات محددة اعتمادًا على نوع البيانات.

​
مثال على رسالة اشتراك

للاشتراك في تدفق أسعار الأسهم المباشرة، أرسل رسالة بتنسيق JSON على النحو التالي: 
{
  "action": "subscribe",
  "symbol": "AAPL",
  "type": "quote"
}

​
آلية النبض

للحفاظ على اتصال مستقر وضمان بقاء العميل والخادم متزامنين، تتضمن واجهة برمجة التطبيقات ويب سوكيت من Benzinga آلية نبض.

​
نبضات من جانب العميل

  • إذا أرسلت رسالة ping كإطار نص عادي (على سبيل المثال، النص ping)، فسيستجيب الخادم برسالة pong كنص عادي (على سبيل المثال، النص pong).
  • يمكن استخدام ذلك للتحقق من بقاء الاتصال نشطًا وقابلًا للاستجابة.

​
مثال

  • يرسل العميل: ping
  • يرد الخادم: pong

​
نبضات من جانب الخادم

  • سيقوم الخادم تلقائيًا بإرسال إطار ping إلى العميل كل 10 ثوانٍ لضمان بقاء الاتصال نشطًا.
  • يُتوقَّع من العميل الرد على إطار الـ ping هذا (وهو ما تتولاه تلقائيًا معظم مكتبات ويب سوكيت).

​
التعامل مع نبضات الاتصال (Heartbeats)

  • أغلب مكتبات عميل WebSocket (مثل تلك في JavaScript أو Python أو Go) تتعامل تلقائيًا مع رسائل ping الواردة من الخادم وترد برسالة pong.
  • ومع ذلك، إذا كنت تطوّر عميل WebSocket مخصصًا، فتأكّد من أنه يستجيب بشكل صحيح لإطارات ping من الخادم لمنع إنهاء الاتصال.

​
تقييد المعدل

يرجى ملاحظة أن واجهة برمجة التطبيقات API الخاصة بـ Benzinga لديها حدود لمعدل الطلبات لمنع سوء الاستخدام وضمان استقرار الخدمة. يُسمح باتصال واحد فقط لكل رمز وصول لواجهة برمجة التطبيقات في الوقت نفسه. إذا تجاوزت حد المعدل، ستتلقى استجابة خطأ.
نأمل أن يساعدك هذا الدليل على البدء في استخدام واجهة برمجة التطبيقات API من Benzinga. إذا كانت لديك أي أسئلة، فلا تتردد في التواصل مع فريق الدعم لدينا.