Skip to main content
GET
Shareholder Holding Details

Plan Access

Notes

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

Supported Markets

Request Parameters

Request Example

Response Fields

The table below lists fields in data; an outer code=0 indicates success. Returns the holdings summary, holding periods, holding details, trading periods, and trading summaries. A structured 404 may be returned when no details are available.

Authorizations

X-API-Key
string
header
required

Query Parameters

symbol
string
required

Stock symbol

Examples:

"AAPL"

"700"

"600519"

"AAPL.US"

"700.HK"

"600519.SH"

type
enum<string>

Product type; currently supports stock

Available options:
stock
object_id
string
required

Object ID from a shareholder holdings record with detail_available=true

Response

Shareholder Holding Details response.

code
integer
required

Business status code; 0 means success.

data
object
required