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 20 major shareholders (institutional, individual, and insider) for a listed company, with support for multi-period comparison. object_id can be passed to shareholder_detail to retrieve full holding history.
Request
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
symbol | string | Required | Security symbol, e.g. `AAPL.US` |
Response
Response properties
| Name | Type | Required | Description |
|---|---|---|---|
periods | array | Optional | Available reporting periods |
info | object[] | Optional | Shareholder data per reporting period |
└ period | string | Optional | Reporting period label (e.g. `Latest`) |
└ share_holders | object[] | Optional | List of shareholders (up to 20) |
└ ∟ object_id | string | Optional | Unique shareholder ID; pass to `shareholder_detail` |
└ ∟ name | string | Optional | Shareholder name |
└ ∟ shares_held | string | Optional | Number of shares held |
└ ∟ percent_shares_held | string | Optional | Ownership percentage, including `%` sign (e.g. `9.71%`) |
└ ∟ shares_changed | string | Optional | Net share count change (positive = bought, negative = sold) |
└ ∟ percent_shares_changed | string | Optional | Change in ownership percentage, including `%` sign |
└ ∟ filing_date | string | Optional | Filing date |
└ ∟ period | string | Optional | Reporting period label (e.g. `Latest`) |
└ ∟ title | string | Optional | Shareholder type (Institution / Individual / Insider) |
Response JSON example
{
"code": 0,
"message": "success",
"data": {
"info": [
{
"period": "Latest",
"share_holders": [
{
"object_id": "148057",
"name": "The Vanguard Group, Inc.",
"title": "",
"shares_held": "1426283914.00",
"percent_shares_held": "9.71%",
"percent_shares_changed": "0.01%",
"shares_changed": "0.00",
"period": "Latest",
"filing_date": "2025/12/31"
},
{
"object_id": "452583",
"name": "BlackRock, Inc.",
"title": "",
"shares_held": "1138572603.00",
"percent_shares_held": "7.75%",
"percent_shares_changed": "-0.06%",
"shares_changed": "-10565359.00",
"period": "Latest",
"filing_date": "2026/03/31"
}
]
}
]
}
}Error code
See the Error Codes page for the full list of error codes.