Stock Events

Stock Events

תשתמשו ב-Stock Events API

ה-Stock Events API הוא פיצ'ר Pro שנועד לאוטומציה של הנתונים בחשבון ה-Stock Events שלכם באמצעות הכלים שלכם. הוא תוכנן לאוטומציה של החשבון, ולא כ-API כללי לנתוני שוק או לחיפוש סימבולים.

בקשות כתיבה (Write requests) משנות את אותם רשימות מעקב (watchlists), סימבולים ועסקאות שאתם רואים ב-Stock Events.

מה אתם יכולים לעשות עם ה-API

  • להציג, ליצור, לשלוף ולעדכן רשימות מעקב (watchlists).
  • להציג, להוסיף, לעדכן ולהסיר סימבולים מרשימת מעקב.
  • להציג, ליצור, לשלוף, לעדכן ולמחוק עסקאות.
  • לקרוא תצוגות מחושבות של החזקות (Holdings) ודיבידנדים (Dividends).

    • איך יוצרים API key

    נדרשת מנוי Pro פעיל ב-Stock Events כדי ליצור ולהשתמש ב-API keys.

    1. התחברו לאפליקציית ה-Web של Stock Events.
    2. פתחו את ה-Profile שלכם.
    3. בחרו ב-Settings.
    4. תחת Account, בחרו ב-Data.
    5. בחרו ב-API Keys.
    6. בחרו ב-Create API key.
    7. הזינו Name תיאורי, ואז בחרו ב-Create.
    8. בחרו ב-Copy API key ושמרו את המפתח בצורה מאובטחת לפני סגירת הדיאלוג.

    מפתח ה-API המלא מוצג רק פעם אחת. אחרי שתסגרו את הדיאלוג, מסך ה-API Keys יציג את השם שלו, הקידומת (prefix), תאריך היצירה ותאריך השימוש האחרון במקום המפתח המלא.

    אם מנוי ה-Pro שלכם הופך ללא פעיל, המפתחות שלכם יישארו מקושרים לחשבון, אבל בקשות ה-API יחזירו 403 Forbidden עד שגישת ה-Pro תחזור להיות פעילה.

    בצעו את הבקשה הראשונה שלכם

    כתובת ה-Base URL של ה-API היא https://stockevents.app/api/v1. שלחו את ה-API key שלכם כ-bearer token בכותרת ה-Authorization.

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

    בקשה זו מחזירה את רשימות המעקב שלכם ואת ה-IDs שלהן. אתם יכולים להשתמש ב-ID של רשימת מעקב עם ה-endpoints של סימבולים, החזקות ודיבידנדים הספציפיים לרשימה.

    עבור שדות בקשה, מבני תגובה, פרמטרים אופציונליים וכל ה-endpoints הזמינים, השתמשו במשאבים האלו:

    שמרו על ה-API key שלכם מאובטח

    תתייחסו ל-API key כמו לסיסמה. אל תעלו אותו ל-source control, אל תחשפו אותו בקוד לקוח ציבורי, ואל תשלחו אותו כפרמטר בשאילתה (query parameter) או בגוף הבקשה (request body).

    מפתחות API מאמתים את ה-API של אוטומציית החשבון ללא הרשאות נפרדות לכל מפתח. השתמשו בהם רק עם כלים שאתם סומכים עליהם.

    אם מפתח נחשף, חזרו ל-API Keys, בחרו ב-Revoke API key, ואז אשרו ב-Revoke. המפתח יפסיק לעבוד מיד ולא ניתן יהיה להפעיל אותו מחדש. צרו מפתח חדש במידת הצורך.

    שגיאות נפוצות

    • 401 Unauthorized: ה-API key חסר, לא תקין או בוטל.
    • 403 Forbidden: לחשבון אין כרגע גישת Pro פעילה.