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 us to easily understand 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
Aggregated Portfolio Schema
The Agreggated Portfolio object contains data that provides an overview of the distribution and yield of all the assets the user has. It can be a report of the last 12 months, current year or currenth month. That period, depending the bank institution we are retrieving (i.e., Itau may bring only a currenth month, when XP may bring last 12 months, and also current year).
Property | Description |
---|---|
percentage | Percentage yield compared to the previous month |
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", "CURRENT_MONTH" or "LAST_TWELVE_MONTHS") |
assetDistribution | Provides a consolidated overview of the distribution of assets the user has |
[
{
"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",
"assetDistribution":
[
{
"MUTUAL_FUND": 2,
"FIXED_INCOME": 1,
"SECURITY": 1,
"ETF": 1,
"EQUITY": 2
}
]
},
{
"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",
"assetDistribution":
[
{
"MUTUAL_FUND": 2,
"FIXED_INCOME": 1,
"SECURITY": 1,
"ETF": 1,
"EQUITY": 2
}
]
},
{
"balance": 721.31,
"percentage": 0.02,
"amount": 19.64,
"currency": "BRL",
"date": "2022-12-28T10:50:36.765Z",
"percentageOverIndex":
{
"value": 0.22,
"index": "CDI"
},
"period": "CURRENT_MONTH",
"assetDistribution":
[
{
"MUTUAL_FUND": 2,
"FIXED_INCOME": 1,
"SECURITY": 1,
"ETF": 1,
"EQUITY": 2
}
]
}
]
Monthly Portfolio Schema
The Monthly Portfolio object contains data that provides an overview of the distribution of all the assets the user has month by month. It will bring the maximum quantity of months the bank institution provides for this product.
Property | Description |
---|---|
yieldPercentage | Percentage yield compared to the period |
yieldAmount | Amount yield over the month |
yieldCurrency | Currency of the yieldAmount |
yieldPercentageOverIndex | Percentage of performance yield on the month retrieved against type of index |
currentMonth | Only true when is currentMonth |
date | First day of the month retrieved |
[
{
"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 5 days ago