> ## 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 Records > Retrieve historical and known future dividend events with date, type, and pagination filters. ## Plan Access | Plan | Available | | - | :-: | | Free | ❌ | | Starter | ✅ | | Professional | ✅ | | Full-Market Plans (A-Shares, HK Stocks, US Stocks) | ✅ | | Enterprise | ✅ | ## Notes * `amount` is the per-share cash dividend as a decimal string and may be `null` for non-cash distributions. The pagination cursor is in the outer `page` object. ## 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` | | `dividend_type` | No | `normal`, `special`, `non_cash`, or `unknown` | | `from` | No | Start date in `YYYY-MM-DD` format | | `to` | No | End date in `YYYY-MM-DD` format | | `limit` | No | Page size; default 100, range `1–500` | | `cursor` | No | Next-page cursor | ## Request Example ```bash theme={null} curl -H "X-API-Key: YOUR_API_KEY" \ "https://api.tickdb.ai/v1/fundamentals/dividends?symbol=AAPL&type=stock&limit=100" ``` ## Response Fields The table below lists fields in `data` and the pagination object; an outer `code=0` indicates success. | Field | Description | | - | - | | symbol | Stock symbol. | | events | Dividend events matching the filters. | | └─ event\_id | Event ID. | | └─ type | Dividend type. | | └─ distribution\_kind | Distribution form. | | └─ amount | Per-share cash amount; may be `null` for non-cash distributions. | | └─ stock\_distribution\_ratio | Bonus-share or capitalization ratio per share; for example, `0.7` means 0.7 additional shares per share, or 7 per 10 shares. | | └─ currency | Currency. | | └─ declaration\_date | Declaration date in `YYYY-MM-DD` format; may be `null`. | | └─ record\_date | Record date in `YYYY-MM-DD` format; may be `null`. | | └─ ex\_date | Ex-dividend date in `YYYY-MM-DD` format; may be `null`. | | └─ payment\_date | Payment date in `YYYY-MM-DD` format; may be `null`. | | └─ description | Event description. | | └─ detail\_level | Detail level. | | page | Pagination information in the outer response. | | └─ next\_cursor | Cursor for the next page; empty on the last page. | | └─ limit | Current page limit. | Each record includes the dividend type, per-share amount, currency, and relevant dates. A future date does not mean the dividend has been completed. ## OpenAPI ````yaml openapi.en.yaml GET /v1/fundamentals/dividends 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: get: tags: - fundamentals-capital-actions summary: Dividend Records description: >- Retrieve historical and known future dividend events with date, type, and pagination filters. operationId: getFundamentalsDividends parameters: - $ref: '#/components/parameters/SymbolQuery' - $ref: '#/components/parameters/TypeQuery' - $ref: '#/components/parameters/DividendTypeQuery' - $ref: '#/components/parameters/FromQuery' - $ref: '#/components/parameters/ToQuery' - $ref: '#/components/parameters/DividendLimitQuery' - $ref: '#/components/parameters/CursorQuery' responses: '200': $ref: '#/components/responses/DividendsResponse' 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` DividendTypeQuery: name: dividend_type in: query required: false schema: type: string enum: - normal - special - non_cash - unknown description: '`normal`, `special`, `non_cash`, or `unknown`' FromQuery: name: from in: query required: false schema: type: string format: date examples: - '2024-01-01T00:00:00.000Z' description: Start date in `YYYY-MM-DD` format ToQuery: name: to in: query required: false schema: type: string format: date examples: - '2026-12-31T00:00:00.000Z' description: End date in `YYYY-MM-DD` format DividendLimitQuery: name: limit in: query required: false schema: type: integer minimum: 1 maximum: 500 default: 100 description: Page size; default 100, range `1–500` CursorQuery: name: cursor in: query required: false schema: type: string minLength: 1 description: Next-page cursor; omit on the first request responses: DividendsResponse: description: Dividend Records response. content: application/json: schema: $ref: '#/components/schemas/DividendsEnvelope' 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: DividendsEnvelope: allOf: - $ref: '#/components/schemas/SuccessEnvelope' - type: object required: - page properties: data: $ref: '#/components/schemas/DividendData' page: $ref: '#/components/schemas/PageInfo' 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. DividendData: type: object required: - symbol - events properties: symbol: type: string description: Stock symbol. events: type: array description: Dividend events matching the filters. items: $ref: '#/components/schemas/DividendEvent' additionalProperties: true PageInfo: type: object required: - next_cursor - limit properties: next_cursor: type: - string - 'null' description: >- Cursor for the next page; pass a non-empty value unchanged as the next request’s `cursor` parameter. `null` on the final page. limit: type: integer minimum: 1 description: Current page limit. additionalProperties: true DividendEvent: type: object required: - event_id - type - distribution_kind - description - amount - stock_distribution_ratio - currency - declaration_date - record_date - ex_date - payment_date - detail_level properties: event_id: type: string description: Event ID. type: type: string enum: - normal - special - non_cash - unknown description: Dividend type. distribution_kind: type: string enum: - cash - stock - other_non_cash - unknown description: Distribution form. description: type: - string - 'null' description: Event description. amount: type: - string - 'null' description: Per-share cash amount; may be `null` for non-cash distributions. stock_distribution_ratio: type: - string - 'null' description: >- Bonus-share or capitalization ratio per share; for example, `0.7` means 0.7 additional shares per share, or 7 per 10 shares. currency: type: - string - 'null' description: Currency. declaration_date: type: - string - 'null' format: date description: Declaration date in `YYYY-MM-DD` format; may be `null`. record_date: type: - string - 'null' format: date description: Record date in `YYYY-MM-DD` format; may be `null`. ex_date: type: - string - 'null' format: date description: Ex-dividend date in `YYYY-MM-DD` format; may be `null`. payment_date: type: - string - 'null' format: date description: Payment date in `YYYY-MM-DD` format; may be `null`. detail_level: type: string enum: - summary - detail description: Detail level. 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.