Felo API PlatformFelo API Platform
全部 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.

取得 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,則為申報文件的 accession number。

  • 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

      申報文件的 accession number。

    • 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

          SEC 網站上該附件文件的 URL。

      • name
        類型: string

        項目名稱。

      • number
        類型: string

        項目編號。

      • text
        類型: string

        項目文字。

    • quarter
      類型: integer

      申報文件所屬的季度。

    • resource
      類型: string

      資源類型識別碼。

    • ticker
      類型: string

      公司的 ticker 代碼。

    • year
      類型: integer

      申報文件所屬年份。

    application/json
  • 202
    類型: object · ResponseE40Feb4D3D6B_FilingItemsAccepted

    申報文件仍在準備中。請輪詢回應本文中的 result_url 取得結果。此回應不計費。

    • accession_number
      類型: string

      正在準備的申報文件的 accession number。

    • estimated_ready_at
      類型: string 格式: date-time

      申報文件預計就緒的時間。

    • message
      類型: string

      下一步動作的人類可讀說明。

    • request_id
      類型: string 格式: uuid

      本次要求的識別碼;聯絡支援時很有用。

    • result_url
      類型: string

      用於輪詢結果的 URL。

    • status
      列舉
      常數:  
      processing

      202 回應時一律為 'processing'。

      值
      • processing
    application/json
  • 400

    無法處理該要求。請檢查請求參數。

  • 401

    需要有效的 Felo API 金鑰。

  • 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

需要協助嗎?