Modular Finance Dataflow

get_owner_portfolio

TOOLGet owner portfolioscope: dataflow:ownership.read · read-only
Tool description, as exposed to the agent
Returns the portfolio of a single owner: every publicly-disclosed equity position the owner holds, ordered by fraction of total share capital owned (largest first). Use search_owners or a row from get_owner_list / get_sub_holdings to obtain the owner_id. Two perspectives are supported: 'beneficial' (positions attributed to the ultimate beneficial owner, e.g. a family or institution that owns through holding companies) and 'manager' (positions attributed to the nearest visible fund or asset manager). Each row reports the company, shares held, fraction of capital, fraction of voting rights (which can differ from capital because of multi-class share structures), position value converted to your organization's configured display currency (value_currency on each row names it), and whether sub-holdings exist beneath this position (has_sub_holdings, drillable via get_sub_holdings). Each row also reports portfolio_weight - the position's share of the owner's entire portfolio value, not of the page returned - together with cost_basis and cost_basis_currency (the owner's average acquisition cost per share, blended across share classes), management_type and management_style (how the owner invests), and owner_parent_id / owner_parent_name where this position sits under a parent owner. The response envelope carries portfolio_value, the whole-portfolio total the weights are fractions of. Pass an 'at' date to retrieve a historical snapshot. Portfolios can be larger 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. For full enumeration of a large portfolio, set limit=100. Successful calls may consume Dataflow credits per position actually returned; an empty result costs zero credits.

Parameters

ParameterTypeDescription
owner_idintegerrequiredThe Modular Finance internal owner_id from search_owners or from a row in get_owner_list / get_sub_holdings. Nonzero integer; the sign of the ID has NO meaning; negative IDs are normal and are NOT a flag for 'unlisted', 'private', or anything else. Pass it through verbatim.
mode'beneficial' | 'manager'optional'beneficial' attributes positions to the ultimate beneficial owner. 'manager' attributes positions to the nearest visible fund or asset manager. 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_treasurybooleanoptionalDenominator 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
atstringoptionalOptional snapshot date in YYYY-MM-DD. Defaults to today UTC.
limitintegeroptionalMaximum number of positions per page. Ordered by capital descending. Hard cap 100. For full enumeration of a portfolio, set limit=100 and paginate 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. Must accompany identical owner_id, mode, at, limit, and min_capital values.max length 512
min_capitalnumberoptionalOptional minimum capital ownership share, fraction 0-1 (0.001 = 0.1%, 0.05 = 5%).min 0 · max 1
include_unlistedbooleanoptionalWhen true, includes positions in companies whose stocks are not currently listed on a public market.default false

Billing

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