Changelog
Introduction

Sections

Theme switcher

EquityServiceExternal


getClientEquityStream: Streams updates of account equity, accepts a PBEquityRequestExternal message with the systemUuid, groups or logins, and flags: includeLocked, includeBlocked and includeStateHistory, returns a stream of PBEquityStreamResponseExternal messages containing PBEquityResponseExternal objects with trading account's login, equity, balance and credit.

Please note that the stream can be resource-intensive.

Although the default update interval is set to 5 seconds, it can be adjusted to a lower value. We recommend using it with caution, as setting very short intervals or subscribing to too many accounts in a single stream may significantly increase server load, consume memory, and potentially impact overall system stability.

The stream allows listening to multiple accounts via groups or logins, so it's advisable to avoid subscribing to all accounts at once through a single connection. Instead, consider splitting the load by creating separate streams per group or segmenting the requests to better manage traffic and reduce strain on the infrastructure.

Request

groupsarray

Show child attributes

loginsarray

Show child attributes

systemUuidstring
includeLockedboolean

If true, accounts with the LOGIN DISABLED access type will be included in the result

includeBlocked boolean

If true, accounts with the TRADING DISABLED access type will be included in the result

includeStateHistoryboolean

If true, last state of equity for each account in range is returned at the beginning of the stream

Response

equityobject

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

1 2 3 4 5 6 7 8 9 10 11 12 { "groups": { "1": "" }, "logins": [ null ], "systemUuid": "", "includeLocked": false, "includeBlocked ": false, "includeStateHistory": false }
Was this section helpful?

What made this section unhelpful for you?