Portfolio Yield (BETA)
The Portfolio Yield entity is recovered from institutions that support this product, creating a one-view of the user’s assets over time performance. Recovering this product will allow an easy understanding on how all the assets of the user are performing over specific periods, providing a consolidated current status.
Portfolio Yield can be separated into two kinds of data objects: Aggregated Portfolio and Monthly Portfolio.
The full data coverage on each institution we connect can be found here.
Aggregated Portfolio Schema
The Agreggated Portfolio object contains data that provides an annual yield overview of all the assets the user has. It can be a report of the last 12 months or the current year (year to date).
Property | Description |
---|---|
balance | Total portfolio balance |
percentage | Percentage yield over the period |
amount | Amount yield over the period |
currency | Currency of the yield amount |
updatedAt | Date when the porfolio was captured |
date | Date of reference of the portfolio |
percentageOverIndex | Percentage of performance yield against type of index |
period | Period from AggregatedPortfolio was retrieved ("CURRENT_YEAR" or "LAST_TWELVE_MONTHS") |
[
{
"balance": 746.3,
"percentage": 0.07,
"amount": 101.56,
"currency": "BRL",
"date": "2022-12-28T10:50:36.765Z",
"percentageOverIndex":
{
"value": 0.64,
"index": "CDI"
},
"period": "CURRENT_YEAR"
},
{
"balance": 91.14,
"percentage": 0.01,
"amount": 85.05,
"currency": "BRL",
"date": "2022-12-28T10:50:36.765Z",
"percentageOverIndex":
{
"value": 0.34,
"index": "CDI"
},
"period": "LAST_TWELVE_MONTHS"
}
]
Monthly Portfolio Schema
The Monthly Portfolio object contains data that provides a monthly yield overview of all the assets the user has. It will bring the maximum quantity of months the bank institution provides for this product.
Property | Description |
---|---|
balance | Total portfolio balance |
yieldPercentage | Percentage yield over the period |
yieldAmount | Amount yield over the period |
yieldCurrency | Currency of the yield amount |
yieldPercentageOverIndex | Percentage of performance yield against type of index |
currentMonth | Only true when is currentMonth. If false, check the field date for the reference month |
date | First day of the reference month |
[
{
"balance": 1782.11,
"yieldPercentage": 0.45,
"yieldAmount": -1315.07,
"yieldCurrency": "BRL",
"date": "2022-12-01T02:00:00.747Z",
"yieldPercentageOverIndex":
{
"value": 10.82,
"index": "CDI"
},
"currentMonth": true
},
{
"balance": 428.55,
"yieldPercentage": 0.44,
"yieldAmount": -968.14,
"yieldCurrency": "BRL",
"date": "2022-11-01T02:00:00.747Z",
"yieldPercentageOverIndex":
{
"value": 12.18,
"index": "CDI"
},
"currentMonth": false
},
{
"balance": 1832.37,
"yieldPercentage": 0.52,
"yieldAmount": 168.22,
"yieldCurrency": "BRL",
"date": "2022-10-01T02:00:00.747Z",
"yieldPercentageOverIndex":
{
"value": 7.14,
"index": "CDI"
},
"currentMonth": false
},
...
]
Updated over 1 year ago