Felo API PlatformFelo API Platform
Tất cả endpoint của Financial Data
v0.2.0-beta
OpenAPI 3.1.0

Lấy các mục hồ sơ SEC

Máy chủ:https://openapi.felo.ai
Thư viện client

Financial Data

​

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

Financial Data Thao tác

Lấy các mục hồ sơ SEC

​

Toàn văn các mục được đánh số trong một hồ sơ SEC. ticker, filing_type (10-K, 10-Q hoặc 8-K) và year đều bắt buộc; thu hẹp thêm bằng quarter, item, accession_number hoặc include_exhibits. Trả về items — mỗi mục gồm number, title và toàn bộ text — cùng filing_url và accession_number. Lưu ý kích thước: một 10-K trả về khoảng 19 mục văn xuôi đầy đủ, nên hãy yêu cầu một item cụ thể thay vì lấy tất cả trừ khi bạn thực sự cần toàn bộ tài liệu. Để tìm hồ sơ nào cần mở trước, dùng get_financial_filings.

Tham chiếu giá

  • Đo lường: Cơ sở chi phí cố định theo yêu cầu thành công.
  • Ước tính tham chiếu cho mỗi yêu cầu: USD 0.02.
  • Hệ số khách hàng tham chiếu: 1.0. Không áp dụng lại cho số tiền khách hàng đã quyết toán.

Chỉ là siêu dữ liệu tham chiếu, không phải báo giá cho tài khoản, mức giá được bảo đảm hay hạn mức chi tiêu. Tín dụng tài nguyên không phải tín dụng Felo. Khoản phí cuối cùng tuân theo bản ghi thanh toán của Felo.

Tham số truy vấn
  • accession_number
    Kiểu: string

    Số truy cập của hồ sơ nếu là 8-K.

  • filing_type
    Kiểu: string enum
    bắt buộc

    Loại hồ sơ.

    giá trị
    • 10-K
    • 10-Q
    • 8-K
  • include_exhibits
    Kiểu: boolean

    Có bao gồm văn bản thô từ các phụ lục được liên kết hay không. Chỉ áp dụng cho hồ sơ 8-K. Khi true, các đối tượng phụ lục sẽ bao gồm trường 'text' chứa toàn bộ nội dung phụ lục.

  • item
    Kiểu: string enum

    Mục cần lấy.

    giá trị
    • Item-1
    • Item-1A
    • Item-1B
    • Item-2
    • Item-3
  • quarter
    Kiểu: integer

    Quý của hồ sơ nếu là 10-Q.

  • ticker
    Kiểu: string
    bắt buộc

    Mã ticker.

  • year
    Kiểu: integer
    bắt buộc

    Năm của hồ sơ.

Phản hồi
  • 200
    Kiểu: object · ResponseE40Feb4D3D6B_FilingItemsResponse

    Phản hồi các mục hồ sơ SEC

    • accession_number
      Kiểu: string

      Số truy cập của hồ sơ.

    • cik
      Kiểu: string

      Central Index Key (CIK) của công ty.

    • filing_type
      Kiểu: string

      Loại hồ sơ.

    • items
      Kiểu: array object[] · ResponseE40Feb4D3D6B_FilingItem[]
      • exhibits
        Kiểu: array object[] · ResponseE40Feb4D3D6B_Exhibit[]

        Mảng phụ lục liên kết với mục này. Chỉ xuất hiện với hồ sơ 8-K khi có phụ lục.

        • description
          Kiểu: string

          Mô tả của phụ lục.

        • number
          Kiểu: string

          Số phụ lục (ví dụ: '99.1').

        • text
          Kiểu: string

          Nội dung văn bản thô của phụ lục. Chỉ được bao gồm khi tham số 'include_exhibits' được đặt thành true.

        • url
          Kiểu: string Định dạng: uri

          URL tới tài liệu phụ lục trên website SEC.

      • name
        Kiểu: string

        Tên của mục.

      • number
        Kiểu: string

        Số của mục.

      • text
        Kiểu: string

        Văn bản của mục.

    • quarter
      Kiểu: integer

      Quý của hồ sơ.

    • resource
      Kiểu: string

      Mã định danh loại tài nguyên.

    • ticker
      Kiểu: string

      Mã ticker của công ty.

    • year
      Kiểu: integer

      Năm của hồ sơ.

    application/json
  • 202
    Kiểu: object · ResponseE40Feb4D3D6B_FilingItemsAccepted

    Hồ sơ vẫn đang được chuẩn bị. Thăm dò result_url trong nội dung phản hồi để lấy kết quả. Bạn không bị tính phí cho phản hồi này.

    • accession_number
      Kiểu: string

      Số truy cập của hồ sơ đang được chuẩn bị.

    • estimated_ready_at
      Kiểu: string Định dạng: date-time

      Thời điểm hồ sơ dự kiến sẵn sàng.

    • message
      Kiểu: string

      Mô tả dễ đọc về bước tiếp theo cần làm.

    • request_id
      Kiểu: string Định dạng: uuid

      Mã định danh cho yêu cầu này; hữu ích khi liên hệ hỗ trợ.

    • result_url
      Kiểu: string

      URL để thăm dò kết quả.

    • status
      enum
      const:  
      processing

      Luôn là 'processing' trên phản hồi 202.

      giá trị
      • processing
    application/json
  • 400

    Không thể xử lý yêu cầu. Hãy kiểm tra các tham số yêu cầu.

  • 401

    Cần có khóa API Felo hợp lệ.

  • 402

    Không thể tiếp tục yêu cầu vì chưa đáp ứng yêu cầu thanh toán.

  • 403

    Tài khoản không được phép thực hiện thao tác này.

  • 429

    Đã đạt giới hạn yêu cầu hoặc giới hạn chi tiêu.

  • 502

    Dịch vụ không thể hoàn tất yêu cầu.

  • 503

    API hoặc dịch vụ thanh toán tạm thời không khả dụng.

  • 504

    Dịch vụ đã hết thời gian chờ khi xử lý yêu cầu.

  • default

    Phản hồi lỗi; phản hồi chuyển tiếp từ thượng nguồn có thể dùng định dạng của nhà cung cấp

    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