Skip to main content
GET
/
investment-products
/
{isin}
/
investment-details
curl -X GET 'https://api.wealthyhood.com/investment-products/IE00B4L5Y983/investment-details' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'x-user-id: 64f0c51e7fb3fc001234abcd'

{
  "currentValue": "£1,254.18",
  "portfolioAllocation": "12.4%",
  "numberOfShares": "15.2500",
  "performanceValue": "+£154.18",
  "performancePercentage": "Up by 14.0%",
  "isPerformancePositive": true,
  "averagePricePerShare": "$72.50",
  "totalDividends": "£18.40"
}

Documentation Index

Fetch the complete documentation index at: https://docs.wealthyhood.com/llms.txt

Use this file to discover all available pages before exploring further.

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

​
Authorization
string
required
Bearer token issued by Auth0. Format: Bearer YOUR_ACCESS_TOKEN with the read:users scope.
​
x-user-id
string
required
24-character MongoDB identifier of the authenticated user. Required to resolve the correct portfolio and currency formatting.

​
Path parameters

​
isin
string
required
ISIN of the investment product to inspect.

​
Example request

curl -X GET 'https://api.wealthyhood.com/investment-products/IE00B4L5Y983/investment-details' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'x-user-id: 64f0c51e7fb3fc001234abcd'

​
Example response

{
  "currentValue": "£1,254.18",
  "portfolioAllocation": "12.4%",
  "numberOfShares": "15.2500",
  "performanceValue": "+£154.18",
  "performancePercentage": "Up by 14.0%",
  "isPerformancePositive": true,
  "averagePricePerShare": "$72.50",
  "totalDividends": "£18.40"
}

​
Response fields

​
currentValue
string
required
Holding valuation formatted in the user’s base currency.
​
portfolioAllocation
string
required
Portfolio share of the asset, returned as a localised percentage string.
​
numberOfShares
string
required
Quantity held, formatted to up to four decimal places.
​
performanceValue
string
required
Absolute performance with sign and currency formatting.
​
performancePercentage
string
required
Localised summary of percentage performance (e.g. Up by 14.0%).
​
isPerformancePositive
boolean
required
Indicates whether the holding performance is positive.
​
averagePricePerShare
string
required
Average acquisition price in the asset’s traded currency.
​
totalDividends
string
required
Total dividend cashflow received for the asset, formatted in the user’s currency.

Authorizations

​
Authorization
string
header
required

Auth0-issued access token that includes the read:users scope.

Headers

​
x-user-id
string
required

MongoDB identifier of the Wealthyhood user whose subscription context should be applied.

Pattern: ^[a-f0-9]{24}$

Path Parameters

​
isin
string
required

ISIN of the investment product to retrieve.

Pattern: ^[A-Z0-9]{12}$

Response

User-centric performance metrics for the asset.

​
currentValue
string
required

Holding valuation formatted in the user's base currency.

​
performanceValue
string
required

Absolute performance formatted with sign.

​
performancePercentage
string
required

Localised percentage summarising performance direction.

​
numberOfShares
string
required
​
portfolioAllocation
string
required
​
isPerformancePositive
boolean
required
​
averagePricePerShare
string
required
​
totalDividends
string
required