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

# Shareholder Holding Details

> Query the holdings and trading details of a shareholder by shareholder object ID.

## Plan Access

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

## Notes

* `object_id` should come from a shareholder holdings record with `detail_available=true`; otherwise, the endpoint may return `404`.

## 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` |
| `object_id` | Yes | Object ID from a shareholder holdings record with `detail_available=true` |

## Request Example

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

## Response Fields

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

| Field | Description |
| - | - |
| symbol | Stock symbol. |
| object\_id | Shareholder object ID. |
| name | Shareholder name. |
| title | Shareholder or institution title. |
| holding\_summary | Holdings summary by reporting period. |
| └─ accum\_buy | Cumulative number of shares purchased during the period. |
| └─ accum\_sell | Cumulative number of shares sold during the period. |
| └─ percent\_stock\_price\_changed | Stock-price percentage change during the period, including the percent sign. |
| └─ period | Reporting period. |
| └─ stock\_price | Stock price associated with the reporting period. |
| holding\_periods | Available holding reporting periods. |
| holding\_details | Holding details by reporting period. |
| └─ filing\_date | Original filing-date text, for example `2026/05/07`. |
| └─ name | Shareholder name. |
| └─ object\_id | Shareholder object ID. |
| └─ percent\_shares\_changed | Change in ownership percentage, including the percent sign. |
| └─ percent\_shares\_held | Ownership percentage, including the percent sign. |
| └─ period | Reporting period. |
| └─ shares\_changed | Change in shares. |
| └─ shares\_held | Number of shares held. |
| trading\_periods | Available trading-statistics periods. |
| tradings | Trading summary by period. |
| └─ accum\_buy | Cumulative number of shares purchased during the period. |
| └─ accum\_sell | Cumulative number of shares sold during the period. |
| └─ net\_buy | Net number of shares purchased during the period. |
| └─ period | Trading-statistics period. |
| └─ trading\_details | Trading detail list for the period. |

Returns the holdings summary, holding periods, holding details, trading periods, and trading summaries. A structured `404` may be returned when no details are available.


## OpenAPI

````yaml openapi.en.yaml GET /v1/fundamentals/shareholders/detail
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/shareholders/detail:
    get:
      tags:
        - fundamentals-holders
      summary: Shareholder Holding Details
      description: >-
        Query the holdings and trading details of a shareholder by shareholder
        object ID.
      operationId: getFundamentalsShareholderDetail
      parameters:
        - $ref: '#/components/parameters/SymbolQuery'
        - $ref: '#/components/parameters/TypeQuery'
        - $ref: '#/components/parameters/ObjectIDQuery'
      responses:
        '200':
          $ref: '#/components/responses/ShareholderDetailResponse'
        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`
    ObjectIDQuery:
      name: object_id
      in: query
      required: true
      schema:
        type: string
      description: >-
        Object ID from a shareholder holdings record with
        `detail_available=true`
  responses:
    ShareholderDetailResponse:
      description: Shareholder Holding Details response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ShareholderDetailEnvelope'
    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:
    ShareholderDetailEnvelope:
      allOf:
        - $ref: '#/components/schemas/SuccessEnvelope'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/ShareholderDetailData'
    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.
    ShareholderDetailData:
      type: object
      required:
        - symbol
        - object_id
        - name
        - holding_summary
        - holding_periods
        - holding_details
        - trading_periods
        - tradings
      properties:
        symbol:
          type: string
          description: Stock symbol.
        object_id:
          type: string
          description: Shareholder object ID.
        name:
          type: string
          description: Shareholder name.
        title:
          type:
            - string
            - 'null'
          description: Shareholder or institution title.
        holding_summary:
          type: array
          description: Holdings summary by reporting period.
          items:
            $ref: '#/components/schemas/ShareholderHoldingSummary'
        holding_periods:
          type: array
          description: Available holding reporting periods.
          items:
            type: string
        holding_details:
          type: array
          description: Holding details by reporting period.
          items:
            $ref: '#/components/schemas/ShareholderHoldingDetail'
        trading_periods:
          type: array
          description: Available trading-statistics periods.
          items:
            type: string
        tradings:
          type: array
          description: Trading summary by period.
          items:
            $ref: '#/components/schemas/ShareholderTradingSummary'
      additionalProperties: false
    ShareholderHoldingSummary:
      type: object
      required:
        - accum_buy
        - accum_sell
        - percent_stock_price_changed
        - period
        - stock_price
      properties:
        accum_buy:
          type: string
          description: Cumulative number of shares purchased during the period.
        accum_sell:
          type: string
          description: Cumulative number of shares sold during the period.
        percent_stock_price_changed:
          type: string
          description: >-
            Stock-price percentage change during the period, including the
            percent sign.
        period:
          type: string
          description: Reporting period.
        stock_price:
          type: string
          description: Stock price associated with the reporting period.
      additionalProperties: false
    ShareholderHoldingDetail:
      type: object
      required:
        - filing_date
        - name
        - object_id
        - percent_shares_changed
        - percent_shares_held
        - period
        - shares_changed
        - shares_held
      properties:
        filing_date:
          type: string
          description: Original filing-date text, for example `2026/05/07`.
        name:
          type: string
          description: Shareholder name.
        object_id:
          type: string
          description: Shareholder object ID.
        percent_shares_changed:
          type: string
          description: Change in ownership percentage, including the percent sign.
        percent_shares_held:
          type: string
          description: Ownership percentage, including the percent sign.
        period:
          type: string
          description: Reporting period.
        shares_changed:
          type: string
          description: Change in shares.
        shares_held:
          type: string
          description: Number of shares held.
      additionalProperties: false
    ShareholderTradingSummary:
      type: object
      required:
        - accum_buy
        - accum_sell
        - net_buy
        - period
        - trading_details
      properties:
        accum_buy:
          type: string
          description: Cumulative number of shares purchased during the period.
        accum_sell:
          type: string
          description: Cumulative number of shares sold during the period.
        net_buy:
          type: string
          description: Net number of shares purchased during the period.
        period:
          type: string
          description: Trading-statistics period.
        trading_details:
          type: array
          description: Trading detail list for the period.
          items:
            type: object
            additionalProperties: true
      additionalProperties: false
  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.