> ## 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.

# Dividend TTM

> TTM means the latest 12 months through the as-of date; retrieve per-share cash dividends aggregated by currency over that period.

## Plan Access

| Plan | Available |
| - | :-: |
| Free | ❌ |
| Starter | ✅ |
| Professional | ✅ |
| Full-Market Plans (A-Shares, HK Stocks, US Stocks) | ✅ |
| Enterprise | ✅ |

## Notes

* The window is based on ex-dividend dates: `ex_date > window_start_exclusive` and `ex_date <= as_of_date`. Different currencies are not combined.

## Supported Markets

| Market | Examples |
| - | - |
| US Stocks | AAPL.US |
| HK Stocks | 700.HK |
| A-Shares | 600519.SH |

## Request Parameters

| Parameter | Required | Description |
| - | :-: | - |
| `symbol` | Yes | Stock symbol |
| `type` | No | Product type; currently supports `stock` |
| `as_of` | No | As-of date in `YYYY-MM-DD` format; defaults to the current date |

## Request Example

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

## Response Fields

The table below lists fields in `data`; an outer `code=0` indicates success.

| Field | Description |
| - | - |
| symbol | Stock symbol. |
| as\_of\_date | TTM as-of date in `YYYY-MM-DD` format. |
| window\_start\_exclusive | Exclusive start of the latest-12-month window in `YYYY-MM-DD` format. |
| currencies | Cash dividends aggregated separately by currency. |
| └─ currency | Dividend currency. |
| └─ normal\_cash\_dps\_ttm | TTM regular cash dividend per share. |
| └─ special\_cash\_dps\_ttm | TTM special cash dividend per share. |
| └─ total\_cash\_dps\_ttm | Total cash dividend per share; this is not dividend yield. |
| └─ normal\_event\_count | Number of regular cash dividend events. |
| └─ special\_event\_count | Number of special cash dividend events. |

Returns regular dividends, special dividends, total cash dividend per share, and event counts separately by currency for the latest 12 months through `as_of`.


## OpenAPI

````yaml openapi.en.yaml GET /v1/fundamentals/dividends/ttm
openapi: 3.1.0
info:
  title: TickDB API
  description: TickDB unified real-time market data API via REST and WebSocket.
  version: 1.0.3
  contact:
    email: support@tickdb.ai
servers:
  - url: https://api.tickdb.ai
    description: Production server
security:
  - ApiKeyAuth: []
paths:
  /v1/fundamentals/dividends/ttm:
    get:
      tags:
        - fundamentals-capital-actions
      summary: Dividend TTM
      description: >-
        TTM means the latest 12 months through the as-of date; retrieve
        per-share cash dividends aggregated by currency over that period.
      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: Stock symbol
    TypeQuery:
      name: type
      in: query
      required: false
      schema:
        type: string
        enum:
          - stock
      description: Product type; currently supports `stock`
    DividendAsOfQuery:
      name: as_of
      in: query
      required: false
      schema:
        type: string
        format: date
      description: As-of date in `YYYY-MM-DD` format; defaults to the current date
  responses:
    DividendsTTMResponse:
      description: Dividend TTM response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/DividendsTTMEnvelope'
    ErrorResponse:
      description: >-
        Error response. Common HTTP statuses include 400 (invalid parameters),
        401 (authentication failed), 403 (permission or quota restriction), 404
        (no matching data), 429 (rate limit), and 503 (service temporarily
        unavailable).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          examples:
            missingAPIKey:
              summary: Missing API key
              value:
                code: '1002'
                message: API key is required. Provide via X-API-Key header
                error: '1002'
            missingKind:
              summary: Missing required parameter
              value:
                code: 40001
                message: kind is required
                data: null
            endpointForbidden:
              summary: API key cannot access this endpoint
              value:
                code: 3009
                message: This endpoint is not allowed for your API key
                data: null
            marketForbidden:
              summary: API key cannot access this market
              value:
                code: 3010
                message: Fundamentals market not allowed for your API key
                data:
                  market: US
            noAvailableSource:
              summary: Data temporarily unavailable
              value:
                code: 5003
                message: Data is temporarily unavailable
                data: null
            notFound:
              summary: No matching data
              value:
                code: 40404
                message: shareholder detail not found
                data: null
            businessNoData:
              summary: No business data matches the query
              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 business error code; may be an integer or string. Convert
            it to a string before comparing.
          oneOf:
            - type: integer
            - type: string
        message:
          type: string
          description: Error description.
        error:
          type: string
          description: >-
            Compatibility error identifier; present only in some error
            responses.
        data:
          description: Optional error context; may be null, an object, or an array.
          oneOf:
            - type: 'null'
            - type: object
              additionalProperties: true
            - type: array
              items: {}
    SuccessEnvelope:
      type: object
      required:
        - code
        - data
      properties:
        code:
          type: integer
          const: 0
          description: Business status code; `0` means success.
    DividendTTMData:
      type: object
      required:
        - symbol
        - as_of_date
        - window_start_exclusive
        - currencies
      properties:
        symbol:
          type: string
          description: Stock symbol.
        as_of_date:
          type: string
          format: date
          description: TTM as-of date in `YYYY-MM-DD` format.
        window_start_exclusive:
          type: string
          format: date
          description: >-
            Exclusive start of the latest-12-month window in `YYYY-MM-DD`
            format.
        currencies:
          type: array
          description: Cash dividends aggregated separately by currency.
          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.