Owner structure
GET {{baseUrl}}/:companyId
Takes optional query parameters
Body
PARAM
Key | Datatype | Required | Description |
depth
|
string | recursion depth | |
includeShareQuotas
|
string | true/false | |
asOfYear
|
string | as of year |
HEADERS
Key | Datatype | Required | Description |
RESPONSES
status OK
{
"hitCount": "<integer>",
"ownerNodes": [
{
"companyId": "<string>",
"count": "<long>",
"holdingsString": "<string>",
"id": "<integer>",
"level": "<integer>",
"name": "<string>",
"ownerHoldings": [
{
"shareCount": "<long>",
"shareType": "<string>",
"totalCount": "<long>"
},
{
"shareCount": "<long>",
"shareType": "<string>",
"totalCount": "<long>"
}
],
"parentId": "<integer>",
"quota": "<string>",
"shareCount": "<long>",
"totalCount": "<long>",
"yearOfBirth": "<string>"
},
{
"companyId": "<string>",
"count": "<long>",
"holdingsString": "<string>",
"id": "<integer>",
"level": "<integer>",
"name": "<string>",
"ownerHoldings": [
{
"shareCount": "<long>",
"shareType": "<string>",
"totalCount": "<long>"
},
{
"shareCount": "<long>",
"shareType": "<string>",
"totalCount": "<long>"
}
],
"parentId": "<integer>",
"quota": "<string>",
"shareCount": "<long>",
"totalCount": "<long>",
"yearOfBirth": "<string>"
}
],
"status": {
"code": "<integer>",
"text": "<string>"
}
} |
ENDPOINTS