Assets
Last updated April 8th, 2024
Our Assets API Endpoint provides all assets that a connected customer account currently holds in their various investment accounts. Information such as the name of the asset, the type e.g stock, the cost, the returns currency, symbol, price etc are all returned.
Response Object
Request
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
{
"status": "successful",
"message": "Request was succesfully completed",
"timestamp": "2024-03-15T15:10:57.842Z",
"data": {
"id": "65d76676c4977cf",
"balances": {
"_u_s_d": 0
},
"assets": [
{
"name": "Mrchemicalmusic",
"type": "Mixed",
"cost": 1071,
"return": 1071,
"quantity": null,
"currency": "USD",
"details": {
"symbol": null,
"price": null,
"current_balance": 0
}
},
{
"name": "Tiv music plan",
"type": "Stocks",
"cost": 3719,
"return": 3781,
"quantity": null,
"currency": "USD",
"details": {
"symbol": null,
"price": null,
"current_balance": 0
}
},
{
"name": "Music",
"type": "Stocks",
"cost": null,
"return": 0,
"quantity": null,
"currency": "USD",
"details": {
"symbol": null,
"price": null,
"current_balance": 0
}
}
]
}
}
Assets Fields
| Field | Description | Type |
| _id | The Asset ID. | string |
| balances | The total balances across all assets. | object |
| assets.name | The name of asset. | string |
| assets.type | The type of asset. | string |
| assets.cost | The total cost incurred on purchasing the asset. | integer |
| assets.return | The unrealized amount gained by the user. | integer |
| assets.quantity | The quantity of asset owned. | integer |
| assets.currency | The currency of asset market in which the price is listed. | string |
| assets.details.symbol | The asset's symbol. | string |
| assets.details.price | The purchase price of the asset. | integer |
| assets.details.current_balance | The current balance obtained from this asset. | integer |