get https://sandbox.onebrick.io/v1/assets/portfolio/
This API helps you to get investment account's portfolio data of your end-users.
Request parameters
| Key Parameter | Data Type | Description |
|---|---|---|
| user_access_token | String | token generated after successful institution connection through the widget which needs to be passed as the Bearer token in the Authorization header |
Response parameters
| Key Parameter | Data type | Description |
|---|---|---|
| asset_type | String | Type of investment asset (stocks / mutual funds / bonds) |
| total_investment | Float | The total investment made for the asset type |
| total_return | Float | The total return of the investment made *can be negative |
| return_percentage | String | The return percentage of the investment made *can be negative |
| equity_summary | Float | The current equity summary of total investment added/subtracted to total return |
| assets_list | List | The list of the assets that falls under the asset type |
| name | String | The name of the assets (For example CPRO for stocks, BNI AM Dana Likuid for mutual funds) |
| lot | Float | The lot amount of the assets |
| amount | Float | The initial value amount of the assets |
| total | Float | The current value amount of the assets |
| percentage | String | The return percentage of the assets *can be negative |
| type | String | The type of assets (For mutual funds example: Pasar Uang, Pasar Saham) |
| average_value | Float | The initial average value of the assets |
| current_value | Float | The current value of the assets |
| return | Float | The total return of the assets *can be negative |