get_sub_holdings
TOOLGet sub-holdingsscope: dataflow:ownership.read · read-only
Tool description, as exposed to the agent
Returns the holdings reported under a single parent owner. Use this when a row from get_owner_list has has_sub_holdings: true and you want to see its sub-managers or individual fund positions. The same tool is used recursively: each returned row is itself an owner that may have its own sub-holdings (indicated by has_sub_holdings), so an agent can keep drilling down level by level. Pass the same company_id and mode you used in the parent call, plus the owner_id of the parent whose children you want. Rows carry the same fields as get_owner_list, including owner_parent_id / owner_parent_name (the level above each row), management_type, management_style, and cost_basis. The sub-holdings can span more than one page (default limit 25, max 100 per page); when next_cursor is present in the response, pass it back as cursor on the next call to retrieve the next page until next_cursor is absent. Successful calls may consume Dataflow credits per owner row actually returned; nested stock breakdowns do not add units, and an empty result costs zero credits.Parameters
| Parameter | Type | Description | |
|---|---|---|---|
| company_id | integer | required | Same company_id used in the parent get_owner_list or get_sub_holdings call. |
| owner_id | integer | required | The owner_id of the parent owner whose sub-holdings you want. |
| mode | 'beneficial' | 'manager' | optional | Must match the mode used to discover this owner. Market convention differs by market: for UK (GB) companies the standard perspective is 'manager', for Nordic companies (SE, NO, DK, FI, IS) it is 'beneficial'. Defaults to your organisation's configured perspective ('beneficial' unless configured otherwise).default "beneficial" |
| adjust_treasury | boolean | optional | Denominator behind every capital and votes fraction in the response. false computes them on total issued shares, including any treasury shares the company holds itself, which is the Nordic standard. true computes them on shares outstanding, excluding treasury shares, which is the UK standard and makes the same holding read slightly higher. Defaults to your organisation's configured basis (unadjusted unless configured otherwise). get_shares_outstanding reports both share counts whatever you pass here.default false |
| limit | integer | optional | Maximum number of sub-holdings per page. Hard cap 100. For full enumeration set limit=100 and page via cursor.default 25 · min 1 · max 100 |
| cursor | string | optional | Opaque pagination token returned as next_cursor by a prior call. Omit on the first call; pass back verbatim to retrieve the next page until next_cursor is absent. Must accompany identical company_id, owner_id, mode, limit, and include_stock_holdings values.max length 512 |
| include_stock_holdings | boolean | optional | default true |
Billing
Pricing keys: sub_holdings.beneficial, sub_holdings.manager. Successful calls consume Dataflow credits per your contract. See Credits & pricing.