v1

latestOpenAPI 3.1.02026-07-24680631.6 KB

Account Summary

Get the detailed account summary

get/accountSummary/{customerId}

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": {
    "utcTime": "2022-04-22T09:39:29Z",
    "accountSummary": {
      "cashAvailableForTrade": 198791.07,
      "cashAvailableForWithdrawal": 201615.21,
      "cashBalance": 198791.07,
      "goodFaithViolations": "5 of 3",
      "restricted": true,
      "cashSettlement": [
        {
          "utcTime": "2022-04-22T13:30:00.001Z"
        }
      ]
    },
    "portfolioSummary": {
      "stockPortfolio": {
        "currentValue": 1173.73,
        "investmentAmount": 1107.39
      },
      "stackPortfolio": {
        "investmentAmount": 6900
      },
      "etfPortfolio": {
        "currentValue": 2156.18,
        "investmentAmount": 853.65
      },
      "totalCurrentValue": 3329.91,
      "totalInvestmentAmount": 8861.04
    }
  }
}