Assets

Our Assets API Endpoint provides all assets that a connected customer 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.

API Object

{
    "_id": "61d7eee5bfa4726033948e81",
    "balances": {
      "USD": 779
    },
    "assets": [
      {
        "_id": "618bb1228a2dcf366b563b1d",
        "name": "Nabors Industries Ltd",
        "type": "stock",
        "cost": 272,
        "return": 686,
        "quantity": 0.09012637,
        "currency": "USD",
        "details": {
          "symbol": "NBR",
          "price": 10630,
          "currentBalance": 484
        }
      }
    ]
}

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 price is listed	string
assets.details.symbol	The asset's symbol	string
assets.details.price	The purchase price of the asset	integer
assets.details.currentBalance	The current balance obtained from this asset	integer