Fundamental
Authorization
Signed mode: every request is signed with your App Key/Secret. Header set:
| Name | Type | Required | Description |
|---|---|---|---|
Authorization | string · header | Required | The account Access Token from the OpenAPI dashboard — passed as the raw token (no Bearer prefix) and included in the signature calculation. |
X-Api-Key | string · header | Required | Your App Key. |
X-Timestamp | string · header | Required | Request timestamp in seconds (Unix epoch). |
X-Api-Signature | string · header | Required | HMAC-SHA256 signature. Format: HMAC-SHA256 SignedHeaders=authorization;x-api-key;x-timestamp, Signature=. |
Get the top institutional and individual shareholders of a company.
Request
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
symbol | string | Required | Security symbol, e.g. `AAPL.US` |
Response
Response properties
| Name | Type | Required | Description |
|---|---|---|---|
shareholder_list | object[] | Optional | List of shareholders |
└ shareholder_id | string | Optional | Shareholder ID |
└ shareholder_name | string | Optional | Shareholder name |
└ percent_of_shares | string | Optional | Percentage of shares held |
└ shares_changed | string | Optional | Change in shares held |
└ report_date | string | Optional | Report date |
└ stocks | array | Optional | Associated stocks |
└ institution_type | string | Optional | Institution type |
total | integer | Optional | Total number of shareholders |
Response JSON example
{
"code": 0,
"message": "success",
"data": {
"forward_url": "",
"total": 33,
"shareholder_list": [
{
"shareholder_name": "Timothy D. Cook",
"percent_of_shares": "2.84",
"institution_type": "",
"report_date": "2026-04-21",
"shareholder_id": "0",
"shares_changed": "0",
"stocks": []
}
]
}
}Error code
See the Error Codes page for the full list of error codes.