> ## 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.
# Get savings product details
> Retrieve comprehensive details about the EUR Money Market Fund savings product.
This endpoint returns detailed information for the `mmf_dist_eur` (EUR Money Market Fund) savings product. The product is fixed and does not need to be specified by the client.
## Response Structure
The response includes three main sections providing comprehensive savings product information:
### Highlights Section
Key performance metrics and earnings information:
* **One-day yield (gross)**: The gross yield before platform fees
* **One-day yield (net)**: The net yield after platform fees
* **Earned last month**: Interest earned in the previous calendar month
* **Lifetime earnings**: Total interest earned since the user started investing
All yield and earnings values are localized according to the user's residency country and displayed in their base currency.
### Information Section
General fund information including:
* Fund name, manager, and ISIN
* Benchmark index
* Base currency
* Income type (distributing vs accumulating)
* Distribution frequency
### Fund Quality Section
Quality metrics and risk assessment:
* Overall fund credit rating (e.g., AAA for money market funds)
* Credit ratings from major agencies (S\&P, Moody's, etc.)
* Risk level (1-7 scale, where 1 is lowest risk)
* Descriptive subtitles for ratings and risk
Use this endpoint to populate detailed savings product screens in your application, showing users comprehensive information about their savings investment.
## Use Cases
This endpoint is ideal for:
* Displaying detailed savings product information pages
* Showing performance metrics and historical earnings
* Providing transparency about fund quality and ratings
* Helping users understand their savings investment
This endpoint requires the user to have an active subscription and savings holdings to calculate personalized earnings metrics.
## OpenAPI
````yaml GET /savings/details
openapi: 3.0.3
info:
title: Wealthyhood Savings Details API
version: 1.0.0
description: >
Retrieve detailed information about savings products for user portfolios.
All requests use machine-to-machine (M2M) authentication. Each request
requires:
- A bearer access token (M2M token with required scopes)
- An `x-user-id` header to specify which user's data to access
servers:
- url: https://{host}
variables:
host:
default: api.wealthyhood.com
description: Wealthyhood API host name.
security:
- bearerAuth: []
tags:
- name: Savings Details
description: >-
Access detailed savings product information including yields, earnings,
and fund quality metrics.
paths:
/savings/details:
get:
tags:
- Savings Details
summary: Get savings product details
description: >
Retrieve comprehensive details about the EUR Money Market Fund
(mmf_dist_eur) savings product.
Returns information about yields, earnings history, fund information,
and quality ratings.
The savings product is fixed to `mmf_dist_eur` and does not need to be
specified by the client.
parameters:
- $ref: '#/components/parameters/XUserId'
responses:
'200':
description: Savings product details retrieved successfully
content:
application/json:
schema:
$ref: '#/components/schemas/SavingsProductData'
example:
highlightsSection:
oneDayYieldGross:
label: One-day yield (gross)
value: 3.75% per year
oneDayYieldNet:
label: One-day yield (net)
value: 3.50% per year
earnedLastMonth:
label: Earned last month
value: €12.45
lifetimeEarnings:
label: Lifetime earnings
value: €156.78
informationSection:
fundName: Euro Money Market Fund
fundManager: ABC Asset Management
isin: LU1234567890
benchmark: ESTR Index
baseCurrency: EUR
income: Distributing
distribution: Monthly
fundQualitySection:
rating: AAA
creditRatings:
- label: Standard & Poor's
rating: AAA
- label: Moody's
rating: Aaa
ratingSubtitle: Highest quality investment grade
risk:
level: 1
subtitle: Very low risk investment
'401':
$ref: '#/components/responses/UnauthorizedError'
'403':
$ref: '#/components/responses/ForbiddenError'
'404':
$ref: '#/components/responses/NotFoundError'
components:
parameters:
XUserId:
name: x-user-id
in: header
required: true
description: >-
User identifier for the M2M client to specify which user's data to
access.
schema:
type: string
pattern: ^[a-f0-9]{24}$
schemas:
SavingsProductData:
type: object
properties:
highlightsSection:
type: object
description: Key highlights and performance metrics for the savings product
properties:
oneDayYieldGross:
$ref: '#/components/schemas/LabelValuePair'
oneDayYieldNet:
$ref: '#/components/schemas/LabelValuePair'
earnedLastMonth:
$ref: '#/components/schemas/LabelValuePair'
lifetimeEarnings:
$ref: '#/components/schemas/LabelValuePair'
informationSection:
type: object
description: General information about the savings fund
properties:
fundName:
type: string
description: Official name of the fund
fundManager:
type: string
description: Asset management company managing the fund
isin:
type: string
description: International Securities Identification Number
benchmark:
type: string
description: Benchmark index the fund tracks or compares against
baseCurrency:
type: string
description: Base currency of the fund (ISO 4217)
income:
type: string
description: Income distribution type (e.g., "Distributing", "Accumulating")
distribution:
type: string
description: Distribution frequency (e.g., "Monthly", "Quarterly")
fundQualitySection:
type: object
description: Quality ratings and risk assessment of the fund
properties:
rating:
type: string
description: Overall fund credit rating (e.g., AAA for money market funds)
creditRatings:
type: array
description: Credit ratings from major rating agencies
items:
$ref: '#/components/schemas/CreditRating'
ratingSubtitle:
type: string
description: Descriptive text explaining the rating
risk:
type: object
description: Risk assessment information
properties:
level:
type: integer
description: Risk level (1-7 scale, 1 being lowest risk)
minimum: 1
maximum: 7
subtitle:
type: string
description: Descriptive text explaining the risk level
LabelValuePair:
type: object
description: A localized label-value pair for displaying metrics
properties:
label:
type: string
description: Localized label text
value:
type: string
description: Formatted value (may include currency symbols or percentages)
CreditRating:
type: object
description: Credit rating from a rating agency
properties:
label:
type: string
description: Name of the rating agency
rating:
type: string
description: Rating assigned by the agency
ApiErrorResponse:
type: object
properties:
status:
type: integer
error:
type: object
properties:
message:
type: string
description:
type: string
nullable: true
responseId:
type: string
format: uuid
responses:
UnauthorizedError:
description: Missing or invalid bearer token.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
status: 401
error:
message: User not found
responseId: 145f2b0d-1d5b-4e91-8d0d-7af0ae9ad13a
ForbiddenError:
description: Authenticated user lacks required scopes.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
status: 403
error:
message: Insufficient permissions
responseId: 5e467f79-c62c-4d83-9810-7a0f8529fd76
NotFoundError:
description: User or savings product was not found.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
status: 404
error:
message: Savings product not found
responseId: 65c0b1f6-2a48-4c4f-a5aa-9b9c8c6f9b58
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: >-
Auth0-issued access token that includes the scopes listed for the
endpoint.
````