API explorerChangelog
API explorer
Changelog

Theme switcher

getEquityStream

Request

groupsarray

Filter by trading group names

Show child attributes

loginsarray

Filter by account logins

Show child attributes

accessRightsFilterarray

Filter by account access rights. CLIENT_ACCESS_RIGHTS_TYPE_UNSPECIFIED = 0 This is the default/empty value and is not used as a filter.

Enum values:
CLIENT_ACCESS_RIGHTS_TYPE_FULL
Full trading access
CLIENT_ACCESS_RIGHTS_TYPE_CLOSE_ONLY
Can only close existing positions
CLIENT_ACCESS_RIGHTS_TYPE_TRADING_DISABLED
Trading disabled, can still log in
CLIENT_ACCESS_RIGHTS_TYPE_TRADING_AND_LOGIN_DISABLED
Both trading and login disabled
CLIENT_ACCESS_RIGHTS_TYPE_LOCKED_CLOSE_ONLY
Locked account, close only

Show child attributes

includeStateHistoryboolean

If true, includes historical state on connect

Response

equityobject

Show child attributes

1 2 3 4 5 6 7 8 9 10 11 12 { "groups": [ "" ], "logins": [ "" ], "accessRightsFilter": [ "" ], "includeStateHistory": false }
View as Markdown

Ask an AI

Open in ChatGPTOpen in ClaudeOpen in Perplexity

Code with AI

Open in Copilot