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

需要帮助?