v1

latestOpenAPI 3.1.02026-07-24680631.6 KB

Get Portfolio Summary

To retrieve the total of holdings

get/{customerId}/portfolio

Path parameters

customerIdstring required

Customer identifier

Headers

api-keystring required

API key

auth-keystring required

Auth key generated using API key & secret

Response

200

statusinteger

Example response

{
  "status": 200,
  "doc": {
    "customerId": "<Customer Identifier>",
    "cashAvailable": 14364.7,
    "total": {
      "investment": 39239.93,
      "currentValue": 43462.59,
      "profitAndLoss": 4222.65,
      "profitAndLossPercent": 10.76
    },
    "stocks": {
      "investment": 12947.75,
      "currentValue": 17670.86
    },
    "stacks": {
      "investment": 26292.18,
      "currentValue": 25791.73
    }
  }
}