GetAccountBalance
GetAccountBalance¶
Command: GetAccountBalance
Deprecated alias: GetUserBalance
GetUserBalance is kept only for backward compatibility. New integrations must use GetAccountBalance; the alias may be removed in a future release.
Description: Returns balance and margin data for the specified login.
Access Control¶
🛡️ Access Level Required:
SESSION_USER,SESSION_CUSTOMER,SESSION_MANAGER,SESSION_ADMIN,SESSION_DEALER
Access Scope¶
User and customer sessions can request only their own linked account balance. For staff sessions, the requested login must be visible through the current cached manager scope: access_backoffice, see_accounts, see_accounts_balance, groups, and brand. Token payload is used only to resolve the manager id and session type.
Endpoint¶
GET /balance/me
Request Parameters¶
| Name | Type | Required | Description |
|---|---|---|---|
login |
int | Yes | Account login |
Response Parameters¶
| Name | Type | Description |
|---|---|---|
balance |
double | Account balance |
credit |
double | Credit |
bonus |
double | Bonus funds stored in the separate bonus bucket |
profit |
double | Floating profit |
commission |
double | Commission |
storage |
double | Storage/swap |
margin |
double | Used margin |
margin_free |
double | Free margin |
margin_level |
double | Margin level |
equity |
double | Equity |
level_type |
int | Margin level type |
leverage |
int | Effective leverage |