> ## 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 Financial Data

> Retrieve trailing-12-month income statement or cash flow metrics aggregated from the latest four valid quarters.

## Plan Access

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

## Notes

* TTM means trailing 12 months and is aggregated from the latest four valid standalone quarters. Only the income statement (`IS`) and cash flow statement (`CF`) are supported.

## 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` |
| `kind` | Yes | Statement type: `IS` income statement or `CF` cash flow statement |

<Note>TTM is defined only for the income statement (`IS`) and cash flow statement (`CF`). Passing the balance sheet (`BS`) returns a parameter error.</Note>

## Request Example

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

## Response Fields

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

| Field | Description |
| - | - |
| symbol | Stock symbol. |
| kind | Statement type: `IS` income statement or `CF` cash flow statement. |
| rows | Trailing-12-month financial metric records. |
| └─ kind | Row statement type: `IS` or `CF`. |
| └─ field\_name | Financial field code; see the [Financial Field Dictionary](./financial_fields_dictionary). |
| └─ field\_display | Display name. |
| └─ indicator\_title | Metric title. |
| └─ value | Aggregated trailing-12-month value returned as a string. |
| └─ currency | Currency. |
| └─ is\_percent | Whether this is a percentage field. |
| └─ fiscal\_year | Corresponding fiscal year. |
| └─ fiscal\_period | Corresponding reporting period. |
| └─ period\_type | `ttm`, indicating an aggregated trailing-12-month value. |
| └─ period\_end | Period end date in `YYYY-MM-DD` format. |
| └─ yoy | Year-over-year change; may be `null`. |
| └─ ratio | Ratio; may be `null`. |

The response contains trailing-12-month metrics aggregated from the latest four valid standalone quarters.


## OpenAPI

````yaml openapi.en.yaml GET /v1/fundamentals/financials/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/financials/ttm:
    get:
      tags:
        - fundamentals-financials
      summary: TTM Financial Data
      description: >-
        Retrieve trailing-12-month income statement or cash flow metrics
        aggregated from the latest four valid quarters.
      operationId: getFundamentalsFinancialsTTM
      parameters:
        - $ref: '#/components/parameters/SymbolQuery'
        - $ref: '#/components/parameters/TypeQuery'
        - $ref: '#/components/parameters/TTMKindQuery'
      responses:
        '200':
          $ref: '#/components/responses/FinancialRowsResponse'
        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`
    TTMKindQuery:
      name: kind
      in: query
      required: true
      schema:
        type: string
        enum:
          - IS
          - CF
      description: 'Statement type: `IS` income statement or `CF` cash flow statement'
  responses:
    FinancialRowsResponse:
      description: Recent Financial Statements response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/FinancialRowsEnvelope'
    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:
    FinancialRowsEnvelope:
      allOf:
        - $ref: '#/components/schemas/SuccessEnvelope'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/FinancialRowsData'
    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.
    FinancialRowsData:
      type: object
      description: >-
        Financial statement data. Numeric values are returned as strings to
        avoid JSON floating-point precision loss.
      required:
        - symbol
        - kind
        - rows
      properties:
        symbol:
          type: string
          description: Stock symbol.
        kind:
          type: string
          enum:
            - IS
            - BS
            - CF
          description: >-
            Statement type: `IS` income statement, `BS` balance sheet, or `CF`
            cash flow statement.
        rows:
          type: array
          description: >-
            Metric records for the selected statement type; a reporting period
            usually contains multiple records.
          items:
            $ref: '#/components/schemas/FinancialRow'
      additionalProperties: true
    FinancialRow:
      type: object
      required:
        - kind
        - period_type
        - fiscal_year
        - fiscal_period
        - period_end
        - field_name
        - indicator_title
        - value
      properties:
        kind:
          type: string
          enum:
            - IS
            - BS
            - CF
          description: >-
            Statement type: `IS` income statement, `BS` balance sheet, or `CF`
            cash flow statement.
        field_name:
          type: string
          description: >-
            Financial field code; see the [Financial Field
            Dictionary](./financial_fields_dictionary).
        indicator_title:
          type: string
          description: Metric title.
        field_display:
          type: string
          description: Display name.
        value:
          oneOf:
            - type: string
            - type: number
            - type: 'null'
          description: Field value returned as a string.
        fiscal_year:
          type: integer
          description: Fiscal year.
        fiscal_period:
          type: string
          description: Reporting period.
        period_type:
          type: string
          description: >-
            Reporting period type: `q1` to `q4` are the four quarters, `saf` is
            semiannual, `af` is annual, and `ttm` is trailing 12 months.
        period_end:
          type: string
          format: date
          description: Period end date in `YYYY-MM-DD` format.
        currency:
          type:
            - string
            - 'null'
          description: Currency.
        is_percent:
          type: boolean
          description: Whether this is a percentage field.
        yoy:
          type:
            - string
            - number
            - 'null'
          description: Year-over-year change; may be `null`.
        ratio:
          type:
            - string
            - number
            - 'null'
          description: Ratio; may be `null`.
      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.