Yellow BoxTrading APIv1 · pre-release

Account

GETAccount information (USER_DATA)

API Description

Balance, equity and margin for one MT5 account, as the trade server reports them.

HTTP Request

HTTP
GET /v1/account

Request Weight

1

Request Parameters

Name Type Mandatory Description
login LONG YES MT5 account. Must be in the key's scope (-2022). An account whose trading is disabled is still READABLE — it answers normally with tradeAllowed: false.
recvWindow LONG NO Default 5000, max 60000.
timestamp LONG YES
signature STRING YES

Response Example

JSON
{
  "login": 100123,
  "group": "real\\BOT\\ECN",
  "currency": "USD",
  "leverage": 100,
  "balance": "10000.0000",
  "credit": "0.0000",
  "equity": "10012.3400",
  "margin": "233.1200",
  "freeMargin": "9779.2200",
  "marginLevel": "4294.60",
  "profit": "12.3400",
  "tradeAllowed": true,
  "updateTime": 1789012345678
}
Field Type Description
login LONG
group STRING MT5 group the account belongs to. Determines symbols, leverage, commissions and whether the account is a cent account. Backslashes are JSON-escaped.
currency STRING Deposit currency. USC means a cent account — see the note above.
leverage INT Account leverage, e.g. 100 for 1:100. 0 if the trade server could not be asked for it on this read.
balance DECIMAL Realised balance. Does not include floating profit.
credit DECIMAL Non-withdrawable credit granted by the broker (bonus or promotional credit). It contributes to margin but is not your money.
equity DECIMAL balance + credit + floating profit.
margin DECIMAL Margin currently used by open positions.
freeMargin DECIMAL Margin available for new positions.
marginLevel DECIMAL equity / margin * 100, in percent, two decimals. "0.00" when no position is open.
profit DECIMAL Total floating profit across open positions. Excludes swap and commission.
tradeAllowed BOOLEAN Whether trading is currently permitted on this account — false when the broker has disabled trading on the account or the trade server reports trading disabled for it. In the first case every TRADE call answers -2024; in the second the order reaches the trade server and is rejected there. Either way this endpoint keeps answering.
updateTime LONG When this snapshot was taken, Unix ms.

Margin call and stop out. Those levels are group settings on the trade server and are not exposed by this API. Track marginLevel yourself and ask the broker for the group's thresholds.