استخدم Stock Events API

تعتبر Stock Events API ميزة مخصصة لمشتركي Pro لأتمتة البيانات في حسابك في Stock Events باستخدام أدواتك الخاصة. هي مصممة لأتمتة الحساب، وليس كواجهة برمجة تطبيقات (API) عامة لبيانات السوق أو البحث عن الرموز.

طلبات الكتابة (Write requests) بتعدل نفس قوائم المراقبة (watchlists)، والرموز (symbols)، والمعاملات (transactions) اللي بتشوفها في Stock Events.

إيش تقدر تسوي باستخدام الـ API

  • عرض، إنشاء، استرجاع، وتحديث قوائم المراقبة (watchlists).
  • عرض، إضافة، تحديث، وحذف الرموز (symbols) من قائمة المراقبة.
  • عرض، إنشاء، استرجاع، تحديث، وحذف المعاملات (transactions).
  • قراءة عرض الحيازات (Holdings) والتوزيعات (Dividends) المحسوبة.

كيف تنشئ مفتاح API

لازم يكون عندك اشتراك Stock Events Pro فعال عشان تقدر تنشئ وتستخدم مفاتيح الـ API.

  1. سجل دخولك لتطبيق Stock Events الويب.
  2. افتح الملف الشخصي (Profile) الخاص بك.
  3. اختر الإعدادات (Settings).
  4. تحت قسم ، اختر البيانات (Data).
  5. اختر مفاتيح الـ API (API Keys).
  6. اختر إنشاء مفتاح API (Create API key).
  7. دخل اسم وصفي، وبعدها اختر إنشاء (Create).
  8. اختر نسخ مفتاح الـ API (Copy API key) واحفظ المفتاح في مكان آمن قبل ما تقفل النافذة.

مفتاح الـ API الكامل بيظهر لك مرة واحدة بس. بعد ما تقفل النافذة، شاشة مفاتيح الـ API بتعرض لك الاسم، والبادئة (prefix)، وتاريخ الإنشاء، وتاريخ آخر استخدام بدلاً من المفتاح الكامل.

إذا صار اشتراك الـ Pro حقك غير فعال، مفاتيحك بتظل مرتبطة بحسابك، بس طلبات الـ API بترجع خطأ 403 Forbidden لحد ما يرجع اشتراك الـ Pro فعال مرة ثانية.

سوي أول طلب لك

الرابط الأساسي (Base URL) للـ API هو https://stockevents.app/api/v1. أرسل مفتاح الـ API حقك كـ bearer token في الـ Authorization header.

curl -H "Authorization: Bearer $STOCK_EVENTS_API_KEY" \    https://stockevents.app/api/v1/watchlists

هذا الطلب بيرجع لك قوائم المراقبة (watchlists) والـ IDs حقتها. تقدر تستخدم ID قائمة المراقبة مع الـ endpoints الخاصة بالرموز، والحيازات (Holdings)، والتوزيعات (Dividends).

عشان تعرف تفاصيل حقول الطلبات، وهياكل الاستجابة، والمعاملات الاختيارية، وكل الـ endpoints المتاحة، استخدم المصادر هذه:

حافظ على أمان مفتاح الـ API حقك

تعامل مع مفتاح الـ API كأنه كلمة مرور. لا ترفعه على أنظمة التحكم في الإصدار (source control)، ولا تخليه مكشوف في كود العميل العام، ولا ترسله في معامل استعلام (query parameter) أو في جسم الطلب (request body).

مفاتيح الـ API بتوثق أتمتة الحساب في الـ API بدون الحاجة لصلاحيات منفصلة لكل مفتاح. استخدمها فقط مع الأدوات اللي تثق فيها.

إذا انكشف مفتاح، ارجع لـ مفاتيح الـ API (API Keys)، واختر إلغاء مفتاح الـ API (Revoke API key)، وبعدها أكد الإلغاء (Revoke). المفتاح بيوقف عن العمل فوراً وما تقدر ترجعه. أنشئ مفتاح بديل إذا احتجت.

أخطاء شائعة

  • 401 Unauthorized: مفتاح الـ API مفقود، أو غير صالح، أو تم إلغاؤه.
  • 403 Forbidden: الحساب حالياً ما عنده وصول فعال لميزات الـ Pro.