Investment Products
Get user investment details
Return portfolio-specific performance metrics for a user-held investment product.
GET
Retrieve personalised portfolio metrics for the authenticated user and the specified ISIN. The
portfolio is validated to ensure the user currently holds the asset; otherwise a
400 Bad Request
error is returned.
Authentication & headers
string
required
Bearer token issued by Auth0. Format:
Bearer YOUR_ACCESS_TOKEN with the read:users scope.string
required
24-character MongoDB identifier of the authenticated user. Required to resolve the correct portfolio
and currency formatting.
Path parameters
string
required
ISIN of the investment product to inspect.
Example request
Example response
Response fields
string
required
Holding valuation formatted in the user’s base currency.
string
required
Portfolio share of the asset, returned as a localised percentage string.
Quantity held, formatted to up to four decimal places.
string
required
Absolute performance with sign and currency formatting.
string
required
Localised summary of percentage performance (e.g.
Up by 14.0%).boolean
required
Indicates whether the holding performance is positive.
Average acquisition price in the asset’s traded currency.
string
required
Total dividend cashflow received for the asset, formatted in the user’s currency.
Authorizations
Auth0-issued access token that includes the read:users scope.
Headers
MongoDB identifier of the Wealthyhood user whose subscription context should be applied.
Pattern:
^[a-f0-9]{24}$Path Parameters
ISIN of the investment product to retrieve.
Pattern:
^[A-Z0-9]{12}$Response
User-centric performance metrics for the asset.
Holding valuation formatted in the user's base currency.
Absolute performance formatted with sign.
Localised percentage summarising performance direction.