Modular Finance Dataflow

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. 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

ParameterTypeDescription
company_idintegerrequiredSame company_id used in the parent get_owner_list or get_sub_holdings call.
owner_idintegerrequiredThe owner_id of the parent owner whose sub-holdings you want.
mode'beneficial' | 'manager'optionalMust match the mode used to discover this owner.default "beneficial"
limitintegeroptionalMaximum 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
cursorstringoptionalOpaque 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_holdingsbooleanoptionaldefault true

Billing

Pricing keys: sub_holdings.beneficial, sub_holdings.manager. Successful calls consume Dataflow credits per your contract. See Credits & pricing.