Felo API PlatformFelo API Platform
همه endpointهای Financial Data
v0.2.0-beta
OpenAPI 3.1.0

دریافت اقلام افشای SEC

Felo API Support
MIT
سرور:https://openapi.felo.ai
کتابخانه‌های کلاینت
Shell Curl

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"
        }
      ]
    }
  ]
}

پاسخ اقلام افشای SEC

Get SEC filing items