> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tickdb.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# 股息TTM

> TTM 指截至统计日的最近 12 个月；查询这段时间内按币种汇总的每股现金股息。

## 套餐权限

| 套餐 | 可用 |
| - | :-: |
| 免费版 | ❌ |
| 基础版 | ✅ |
| 专业版 | ✅ |
| 全量套餐（A 股、港股、美股） | ✅ |
| 企业版 | ✅ |

## 注意事项

* 统计窗口按除息日计算：`ex_date > window_start_exclusive` 且 `ex_date <= as_of_date`；不同币种不合并。

## 支持的市场

| 市场 | 示例 |
| - | - |
| 美股 | AAPL.US |
| 港股 | 700.HK |
| A股 | 600519.SH |

## 请求参数

| 参数 | 是否必须 | 说明 |
| - | :-: | - |
| `symbol` | 是 | 股票代码 |
| `type` | 否 | 产品类型，当前支持 `stock` |
| `as_of` | 否 | 统计截止日，格式 `YYYY-MM-DD`；默认当前日期 |

## 请求示例

```bash theme={null}
curl -H "X-API-Key: YOUR_API_KEY" \
  "https://api.tickdb.ai/v1/fundamentals/dividends/ttm?symbol=AAPL&type=stock"
```

## 返回字段说明

以下列出 `data` 中的字段；外层 `code=0` 表示成功。

| 字段 | 说明 |
| - | - |
| symbol | 股票代码。 |
| as\_of\_date | TTM 统计截止日，格式 `YYYY-MM-DD`。 |
| window\_start\_exclusive | 最近 12 个月窗口的排他起点，格式 `YYYY-MM-DD`。 |
| currencies | 按币种分别汇总的现金股息列表。 |
| └─ currency | 分红币种。 |
| └─ normal\_cash\_dps\_ttm | 普通现金每股股息 TTM。 |
| └─ special\_cash\_dps\_ttm | 特别现金每股股息 TTM。 |
| └─ total\_cash\_dps\_ttm | 现金每股股息合计；不是股息率。 |
| └─ normal\_event\_count | 普通现金分红事件次数。 |
| └─ special\_event\_count | 特别现金分红事件次数。 |

按币种返回普通股息、特殊股息、合计现金每股股息及事件数量。统计窗口为截至 `as_of` 的最近 12 个月。


## OpenAPI

````yaml openapi.yaml GET /v1/fundamentals/dividends/ttm
openapi: 3.1.0
info:
  title: TickDB API
  description: TickDB 统一实时行情数据 API，提供 REST 和 WebSocket 接入。
  version: 1.0.3
  contact:
    email: support@tickdb.ai
servers:
  - url: https://api.tickdb.ai
    description: 生产环境
security:
  - ApiKeyAuth: []
paths:
  /v1/fundamentals/dividends/ttm:
    get:
      tags:
        - fundamentals-capital-actions
      summary: 股息TTM
      description: TTM 指截至统计日的最近 12 个月；查询这段时间内按币种汇总的每股现金股息。
      operationId: getFundamentalsDividendsTTM
      parameters:
        - $ref: '#/components/parameters/SymbolQuery'
        - $ref: '#/components/parameters/TypeQuery'
        - $ref: '#/components/parameters/DividendAsOfQuery'
      responses:
        '200':
          $ref: '#/components/responses/DividendsTTMResponse'
        default:
          $ref: '#/components/responses/ErrorResponse'
components:
  parameters:
    SymbolQuery:
      name: symbol
      in: query
      required: true
      schema:
        type: string
        examples:
          - AAPL
          - '700'
          - '600519'
          - AAPL.US
          - 700.HK
          - 600519.SH
      description: 股票代码
    TypeQuery:
      name: type
      in: query
      required: false
      schema:
        type: string
        enum:
          - stock
      description: 产品类型，当前支持 `stock`
    DividendAsOfQuery:
      name: as_of
      in: query
      required: false
      schema:
        type: string
        format: date
      description: 统计截止日，格式 `YYYY-MM-DD`；默认当前日期
  responses:
    DividendsTTMResponse:
      description: 股息TTM响应。
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/DividendsTTMEnvelope'
    ErrorResponse:
      description: >-
        错误响应。常见 HTTP 状态包括
        400（参数错误）、401（鉴权失败）、403（权限或配额限制）、404（无匹配数据）、429（请求频率限制）和 503（服务暂不可用）。
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          examples:
            missingAPIKey:
              summary: 缺少 API Key
              value:
                code: '1002'
                message: API key is required. Provide via X-API-Key header
                error: '1002'
            missingKind:
              summary: 缺少必填参数
              value:
                code: 40001
                message: kind is required
                data: null
            endpointForbidden:
              summary: API Key 无权访问该接口
              value:
                code: 3009
                message: This endpoint is not allowed for your API key
                data: null
            marketForbidden:
              summary: API Key 未开放该市场
              value:
                code: 3010
                message: Fundamentals market not allowed for your API key
                data:
                  market: US
            noAvailableSource:
              summary: 数据暂不可用
              value:
                code: 5003
                message: Data is temporarily unavailable
                data: null
            notFound:
              summary: 无匹配数据
              value:
                code: 40404
                message: shareholder detail not found
                data: null
            businessNoData:
              summary: 查询条件无有效业务数据
              value:
                code: 40405
                message: valuation time series not found
                data: null
  schemas:
    DividendsTTMEnvelope:
      allOf:
        - $ref: '#/components/schemas/SuccessEnvelope'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/DividendTTMData'
    ErrorEnvelope:
      type: object
      required:
        - code
        - message
      properties:
        code:
          description: TickDB API 业务错误码；可能为整数或字符串，客户端应归一化为字符串后比较。
          oneOf:
            - type: integer
            - type: string
        message:
          type: string
          description: 错误说明。
        error:
          type: string
          description: 兼容错误标识；仅部分错误响应返回。
        data:
          description: 可选的错误上下文；可能为 null、对象或数组。
          oneOf:
            - type: 'null'
            - type: object
              additionalProperties: true
            - type: array
              items: {}
    SuccessEnvelope:
      type: object
      required:
        - code
        - data
      properties:
        code:
          type: integer
          const: 0
          description: 业务状态码，成功为 0。
    DividendTTMData:
      type: object
      required:
        - symbol
        - as_of_date
        - window_start_exclusive
        - currencies
      properties:
        symbol:
          type: string
          description: 标准化股票代码。
        as_of_date:
          type: string
          format: date
          description: TTM 截止日。
        window_start_exclusive:
          type: string
          format: date
          description: 十二个月窗口的排他起点。
        currencies:
          type: array
          description: 按币种汇总；窗口内没有符合条件的现金分红时为空数组。
          items:
            $ref: '#/components/schemas/DividendTTMCurrency'
      additionalProperties: true
    DividendTTMCurrency:
      type: object
      required:
        - currency
        - normal_cash_dps_ttm
        - special_cash_dps_ttm
        - total_cash_dps_ttm
        - normal_event_count
        - special_event_count
      properties:
        currency:
          type: string
        normal_cash_dps_ttm:
          type: string
        special_cash_dps_ttm:
          type: string
        total_cash_dps_ttm:
          type: string
        normal_event_count:
          type: integer
          minimum: 0
        special_event_count:
          type: integer
          minimum: 0
      additionalProperties: true
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.