Felo API PlatformFelo API Platform
כל ה-endpoints של Financial Data
v0.2.0-beta
OpenAPI 3.1.0

קבלת פריטי הגשת SEC

שרת:https://openapi.felo.ai
ספריות לקוח

Financial Data

​

Company fundamentals, financial statements, market prices and economic data.

Financial Data פעולות

קבלת פריטי הגשת SEC

​

הטקסט המלא של הפריטים הממוספרים בתוך הגשת SEC אחת. ticker, filing_type (10-K, 10-Q או 8-K) ו-year כולם חובה; צמצמו עוד עם quarter, item, accession_number או include_exhibits. מחזיר items — כל אחד עם number, title והטקסט המלא text — וכן filing_url ו-accession_number. שימו לב לגודל: 10-K חוזר ככ-19 פריטים של פרוזה מלאה, לכן בקשו item ספציפי ולא הכול, אלא אם באמת דרוש לכם המסמך השלם. כדי לגלות איזו הגשה לפתוח מלכתחילה, השתמשו ב-get_financial_filings.

מראה תמחור

  • מדידה: בסיס עלות קבוע לבקשה מוצלחת.
  • אומדן בקשת ייחוס: 0.02 דולר ארה״ב.
  • מכפיל לקוח לייחוס: 1.0. אין להחיל אותו בשנית על סכום לקוח שכבר נקבע.

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

פרמטרי שאילתה
  • accession_number
    סוג: string

    מספר ההצטרפות של ההגשה אם 8-K.

  • filing_type
    סוג: string enum
    חובה

    סוג ההגשה.

    ערכים
    • 10-K
    • 10-Q
    • 8-K
  • include_exhibits
    סוג: boolean

    האם לכלול את הטקסט הגולמי מהנספחים המקושרים. רלוונטי להגשות 8-K בלבד. כאשר true, אובייקטי הנספחים יכללו את השדה 'text' המכיל את תוכן הנספח המלא.

  • item
    סוג: string enum

    הפריט לאחזור.

    ערכים
    • Item-1
    • Item-1A
    • Item-1B
    • Item-2
    • Item-3
  • quarter
    סוג: integer

    הרבעון של ההגשה אם 10-Q.

  • ticker
    סוג: string
    חובה

    סמל הטיקר.

  • year
    סוג: integer
    חובה

    שנת ההגשה.

תגובות
  • 200
    סוג: object · ResponseE40Feb4D3D6B_FilingItemsResponse

    תגובת פריטי הגשת SEC

    • accession_number
      סוג: string

      מספר ההצטרפות של ההגשה.

    • cik
      סוג: string

      מפתח האינדקס המרכזי (CIK) של החברה.

    • filing_type
      סוג: string

      סוג ההגשה.

    • items
      סוג: array object[] · ResponseE40Feb4D3D6B_FilingItem[]
      • exhibits
        סוג: array object[] · ResponseE40Feb4D3D6B_Exhibit[]

        מערך של נספחים המקושרים לפריט זה. קיים רק עבור הגשות 8-K כאשר קיימים נספחים.

        • description
          סוג: string

          התיאור של הנספח.

        • number
          סוג: string

          מספר הנספח (למשל '99.1').

        • text
          סוג: string

          תוכן הטקסט הגולמי של הנספח. נכלל רק כאשר הפרמטר 'include_exhibits' מוגדר ל-true.

        • url
          סוג: string פורמט: uri

          כתובת ה-URL של מסמך הנספח באתר SEC.

      • name
        סוג: string

        שם הסעיף.

      • number
        סוג: string

        מספר הסעיף.

      • text
        סוג: string

        טקסט הסעיף.

    • quarter
      סוג: integer

      הרבעון של ההגשה.

    • resource
      סוג: string

      מזהה סוג המשאב.

    • ticker
      סוג: string

      סמל הטיקר של החברה.

    • year
      סוג: integer

      שנת ההגשה.

    application/json
  • 202
    סוג: object · ResponseE40Feb4D3D6B_FilingItemsAccepted

    ההגשה עדיין בהכנה. בדקו את מצב result_url מגוף התגובה כדי לשלוף את התוצאה. התגובה הזו אינה מחויבת.

    • accession_number
      סוג: string

      מספר ההצטרפות של ההגשה שנמצאת בהכנה.

    • estimated_ready_at
      סוג: string פורמט: date-time

      מתי ההגשה צפויה להיות מוכנה.

    • message
      סוג: string

      תיאור קריא של מה לעשותต่อไป.

    • request_id
      סוג: string פורמט: uuid

      מזהה לבקשה זו; שימושי בעת פנייה לתמיכה.

    • result_url
      סוג: string

      כתובת ה-URL לבדיקה חוזרת של התוצאה.

    • status
      enum
      const:  
      processing

      תמיד 'processing' בתגובת 202.

      ערכים
      • processing
    application/json
  • 400

    לא ניתן היה לעבד את הבקשה. בדקו את פרמטרי הבקשה.

  • 401

    נדרש מפתח API תקף של Felo.

  • 402

    לא ניתן להמשיך את הבקשה משום שדרישת חיוב אינה מתקיימת.

  • 403

    החשבון אינו מורשה לבצע את הפעולה הזו.

  • 429

    הגעתם למגבלת בקשות או לתקרת הוצאה.

  • 502

    השירות לא הצליח להשלים את הבקשה.

  • 503

    שירות ה-API או החיוב אינו זמין באופן זמני.

  • 504

    השירות פג בזמן הטיפול בבקשה.

  • default

    תגובת שגיאה; תגובות מעבר מהמעלה הזרם עשויות להשתמש בפורמטים של הספק

    application/json
Request Example for get/v1/beta/financial/filings/items
curl 'https://openapi.felo.ai/v1/beta/financial/filings/items?filing_type=10-K&ticker=&year=1' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "resource": "string",
  "ticker": "string",
  "cik": "string",
  "filing_type": "string",
  "accession_number": "string",
  "year": 1,
  "quarter": 1,
  "items": [
    {
      "number": "string",
      "name": "string",
      "text": "string",
      "exhibits": [
        {
          "number": "string",
          "description": "string",
          "url": "https://example.com",
          "text": "string"
        }
      ]
    }
  ]
}
Get SEC filing items