API reference

Holdings

GET/Holdings/{id}

MCP tool get_holdingsCore license

Returns portfolio holdings for a client as of a month-end, in the reporting currency you choose. One row per position, with security identifiers, cost, market value and accrued interest.

Parameters

Name	In	Type		Description
`id`	path	integer	required	Client id from `/Clients`. `0` returns all clients you can access.
`yearMonth`	query	integer	required	Month-end to report, `YYYYMM`. Example: `202509`.
`ccy`	query	string	optional	Reporting currency, for example `USD` or `MXN`. Default `USD`.
`historicalMonths`	query	integer	optional	Number of month-ends to return, counting back from `yearMonth`. `1` to `12`, default `1`. Use the `date` field to tell months apart.
`investmentVehicle`	query	string	optional	Only return holdings of this investment vehicle. Default: all.
`nodeId`	query	string	optional	Only return holdings under this GWM node, for example `"3_1842"`. Default: all.
`tenantId`	query	string	optional	Tenant to query, from `/Tenants`. Default: your user's main tenant.

Example request

Response

Response fields

Field	Type	Description
`clientID`	string	Client ID as shown in Clients.
`clientAlias`	string	Client alias.
`parentNodeId`	string	Node this position sits under in the GWM.
`bankBroker`	string \| null	Bank or broker holding the position.
`accountNumber`	string \| null	Account number, when it applies.
`assetName`	string	Asset name from the GWM asset catalogue.
`nodeId`	string	Unique id of the position's node.
`securityId`	integer	Masttro security id.
`isin`	string	ISIN of the security.
`sedol`	string	SEDOL of the security.
`cusip`	string	CUSIP of the security.
`ticker`	string	Ticker of the security.
`assetClass`	string	Asset class as defined in your Asset Master.
`securityType`	string	Security type as defined in your Asset Master.
`sector`	string	Sector of the holding.
`geographicExposure`	string	Geographic exposure of the holding.
`quantity`	string	Quantity held. The format depends on the security type.
`unitCost`	number \| null	Cost per unit.
`totalCost`	number \| null	Total cost of all units.
`price`	number \| null	Last price, in local currency.
`marketValue`	number \| null	Market value, in reporting currency.
`localCCY`	string	Local currency of the holding.
`localMarketValue`	number \| null	Market value, in local currency.
`accruedInterest`	number \| null	Accrued interest, in reporting currency.
`localAccruedInterest`	number \| null	Accrued interest, in local currency.
`date`	string	Effective date of the holding.
`assetManager`	string	Asset manager responsible for the holding.

Errors

Status	Body
`400`	`"The user does not have access to this client or the client does not exist."`
`400`	`"The value of historicalMonths must be between 1 and 12."`
`400`	Validation problem when `yearMonth` is missing or not a number.
`400`	`"The user does not have access to this tenant or the tenant does not exist."`

Plus the common 401 and 429 responses. See Errors.