Get account portfolio

Read cash balances, buying power, and positions for the specified client account.

Response structure

The result contains summary fields such as totalCash, totalAvailCash, availPp, usedPp, totalMktValue, and pl. Monetary values and numeric quantities in this response are returned as strings. Buying power (availPp) is distinct from cash balance.

  • cashPos holds cash data. When there is no cash data, it can be an empty string (""). A single-currency response can contain one object in cashPos.cash; do not assume it is always an array.
  • productPos holds position data. When there are no positions, it can be an empty string ("").
  • limits.limit contains limitCode / limitValue entries.

These fields are named cashPos and productPos, not cashList and productList.

Errors

An unknown or unbound brokerClientId returns HTTP 200 with business code 112003, for example {"code":112003,"message":"Account not found or not bound"}. Error responses can omit data.

Query Params
string
required

Account ID identifying the client account for the request.

Headers
string

Trace ID. Generated by the server if omitted.

Responses

Language
LoadingLoading…
Response
Choose an example:
application/json