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

ข้อมูลอ้างอิงราคา

  • การวัดปริมาณการใช้งาน: ฐานต้นทุนคำขอที่สำเร็จแบบคงที่
  • ค่าประมาณคำขออ้างอิง: USD 0.02
  • ตัวคูณอ้างอิงสำหรับลูกค้า: 1.0 ห้ามนำไปใช้ซ้ำกับยอดที่เรียกเก็บจากลูกค้าแล้ว

เป็นข้อมูลเมตาอ้างอิงเท่านั้น ไม่ใช่ใบเสนอราคาสำหรับบัญชี ไม่ใช่ราคาที่รับประกัน และไม่ใช่เพดานการใช้จ่าย เครดิตของทรัพยากรไม่ใช่เครดิต Felo ยอดเรียกเก็บขั้นสุดท้ายเป็นไปตามบันทึกการเรียกเก็บเงินของ Felo

พารามิเตอร์ในคิวรี
  • accession_number
    ประเภท: string

    หมายเลข accession ของเอกสารหากเป็น 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
    จำเป็น

    สัญลักษณ์ ticker

  • year
    ประเภท: integer
    จำเป็น

    ปีของเอกสาร

การตอบกลับ
  • 200
    ประเภท: object · ResponseE40Feb4D3D6B_FilingItemsResponse

    การตอบกลับรายการเอกสาร SEC

    • accession_number
      ประเภท: string

      หมายเลข accession ของเอกสารยื่น

    • cik
      ประเภท: string

      Central Index Key (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

      สัญลักษณ์ ticker ของบริษัท

    • year
      ประเภท: integer

      ปีของเอกสาร

    application/json
  • 202
    ประเภท: object · ResponseE40Feb4D3D6B_FilingItemsAccepted

    เอกสารยังอยู่ระหว่างการจัดเตรียม ให้ poll result_url จากเนื้อหาการตอบกลับเพื่อดึงผลลัพธ์ คุณจะไม่ถูกเรียกเก็บเงินสำหรับการตอบกลับนี้

    • accession_number
      ประเภท: string

      หมายเลข accession ของเอกสารยื่นที่กำลังจัดเตรียม

    • estimated_ready_at
      ประเภท: string รูปแบบ: date-time

      เวลาที่คาดว่าเอกสารยื่นจะพร้อม

    • message
      ประเภท: string

      คำอธิบายที่มนุษย์อ่านได้ว่าต้องทำอะไรต่อไป

    • request_id
      ประเภท: string รูปแบบ: uuid

      ตัวระบุสำหรับคำขอนี้ มีประโยชน์เมื่อติดต่อฝ่ายสนับสนุน

    • result_url
      ประเภท: string

      URL สำหรับ poll ผลลัพธ์

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

การตอบกลับรายการเอกสาร SEC

Get SEC filing items