openapi: 3.1.0
info:
  title: TickFlow 行情数据 API
  description: |-
    高性能行情数据服务，支持 A股、ETF、美股、港股。

    ## 认证方式

    所有接口需要通过 `x-api-key` 请求头传递 API Key 进行认证。

    ## 速率限制

    根据 API Key 配置的权限，可能会有请求频率和配额限制。

    ## 批量查询

    部分接口同时支持 GET 和 POST 方法：
    - **GET**: 通过 URL 参数传递，适合少量数据
    - **POST**: 通过 JSON Body 传递，适合大批量查询，不受 URL 长度限制

    ## K线周期

    支持的周期：1m, 5m, 10m, 15m, 30m, 60m, 1d, 1w, 1M, 1Q, 1Y
    - 日内周期(5m/15m/30m/60m)从1m数据聚合
    - 周线(1w)/月线(1M)/季线(1Q)/年线(1Y)从日线聚合
    - intraday 接口当前为 Beta 版本
  contact:
    name: TickFlow Team
  license:
    name: ''
  version: 1.0.0
servers:
  - url: https://api.tickflow.org
security:
  - api_key: []
paths:
  /v1/financials/metrics:
    get:
      tags:
        - 财务数据
      summary: 查询核心财务指标
      description: 获取指定标的的核心财务指标，包含每股指标、盈利能力、成长性和偿债能力。
      operationId: get_metrics
      parameters:
        - name: symbols
          in: query
          description: 逗号分隔的标的代码，如 600519.SH,000001.SZ
          required: true
          schema:
            type: string
        - name: start_date
          in: query
          description: 起始日期过滤（可选，YYYY-MM-DD），筛选 period_end >= start_date
          required: false
          schema:
            type:
              - string
              - 'null'
        - name: end_date
          in: query
          description: 截止日期过滤（可选，YYYY-MM-DD），筛选 period_end <= end_date
          required: false
          schema:
            type:
              - string
              - 'null'
        - name: latest
          in: query
          description: 仅返回最新一期（默认 false）
          required: false
          schema:
            type:
              - boolean
              - 'null'
      responses:
        '200':
          description: 查询成功
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricsResponse'
        '400':
          description: 参数错误
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: 认证失败
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: 无权限
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      security:
        - api_key: []
components:
  schemas:
    MetricsResponse:
      type: object
      description: 核心财务指标响应
      required:
        - data
      properties:
        data:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/MetricsRecord'
          propertyNames:
            type: string
    ApiError:
      type: object
      description: API 错误响应体
      required:
        - code
        - message
      properties:
        code:
          type: string
          description: 错误代码 (如 "INVALID_PERIOD", "SYMBOL_NOT_FOUND")
          example: INVALID_PERIOD
        details:
          description: 详细信息 (可选，用于调试)
        message:
          type: string
          description: 错误消息 (人类可读)
          example: 'Invalid period: 2d'
    MetricsRecord:
      type: object
      description: 核心财务指标（每股指标 + 盈利能力 + 成长性 + 偿债能力）
      required:
        - period_end
      properties:
        announce_date:
          type:
            - string
            - 'null'
          description: 公告日期 (YYYY-MM-DD)
        bps:
          type:
            - number
            - 'null'
          format: double
          description: 每股净资产 (Book Value per Share)
        debt_to_asset_ratio:
          type:
            - number
            - 'null'
          format: double
          description: 资产负债率 (Debt-to-Asset Ratio)
        eps_basic:
          type:
            - number
            - 'null'
          format: double
          description: 基本每股收益 (Basic EPS)
        eps_diluted:
          type:
            - number
            - 'null'
          format: double
          description: 稀释每股收益 (Diluted EPS)
        gross_margin:
          type:
            - number
            - 'null'
          format: double
          description: 毛利率 (Gross Margin)
        inventory_turnover:
          type:
            - number
            - 'null'
          format: double
          description: 存货周转率 (Inventory Turnover)
        net_income_yoy:
          type:
            - number
            - 'null'
          format: double
          description: 净利润同比增长率 (Net Income YoY Growth)
        net_margin:
          type:
            - number
            - 'null'
          format: double
          description: 净利率 (Net Margin)
        ocfps:
          type:
            - number
            - 'null'
          format: double
          description: 每股经营现金流 (Operating Cash Flow per Share)
        operating_cash_to_revenue:
          type:
            - number
            - 'null'
          format: double
          description: 销售现金比率 (Operating Cash to Revenue)
        period_end:
          type: string
          description: 报告期末日期 (YYYY-MM-DD)
        revenue_yoy:
          type:
            - number
            - 'null'
          format: double
          description: 营收同比增长率 (Revenue YoY Growth)
        roa:
          type:
            - number
            - 'null'
          format: double
          description: 总资产收益率 (ROA)
        roe:
          type:
            - number
            - 'null'
          format: double
          description: 净资产收益率 (ROE)
        roe_diluted:
          type:
            - number
            - 'null'
          format: double
          description: 摊薄净资产收益率 (Diluted ROE)
  securitySchemes:
    api_key:
      type: apiKey
      in: header
      name: x-api-key