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 تعداد
    مطلوب

    نوع الإيداع.

    القيم
    • 10-K
    • 10-Q
    • 8-K
  • include_exhibits
    النوع: boolean

    هل يُضمَّن النص الخام من المستندات المرفقة المرتبطة. ينطبق على إيداعات 8-K فقط. عند true، ستتضمن كائنات المستندات المرفقة الحقل 'text' الذي يحتوي محتوى المستند المرفق كاملًا.

  • item
    النوع: string تعداد

    العنصر المراد الحصول عليه.

    القيم
    • 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
      تعداد
      ثابت:  
      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