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 in USD, and whether sub-holdings exist beneath this position (has_sub_holdings, drillable via get_sub_holdings). 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
| Parameter | Type | Description | |
|---|---|---|---|
| owner_id | integer | required | The 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.default "beneficial" |
| at | string | optional | Optional snapshot date in YYYY-MM-DD. Defaults to today UTC. |
| limit | integer | optional | Maximum 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 |
| 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. Must accompany identical owner_id, mode, at, limit, and min_capital values.max length 512 |
| min_capital | number | optional | Optional minimum capital ownership share, fraction 0-1 (0.001 = 0.1%, 0.05 = 5%).min 0 · max 1 |
| include_unlisted | boolean | optional | When 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.