Skip to content

Metatrader account information#

About#

Contains account information for a MetaTrader account

Fields#

Name Type Required Description
platform string Yes platform id, enum: mt4, mt5
broker string Yes broker name
currency string Yes account base currency
server string Yes broker server name
balance number Yes account balance
equity number Yes account liquidation value
margin number Yes margin used
freeMargin number Yes free margin
leverage number Yes account leverage
marginLevel number margin level calculated as % of equity/margin
tradeAllowed boolean Yes flag indicating that trading is allowed
investorMode boolean flag indicating that investor password was used (supported for g2 only)
marginMode string Yes margin calculation mode. enum: ACCOUNT_MARGIN_MODE_EXCHANGE, ACCOUNT_MARGIN_MODE_RETAIL_NETTING, ACCOUNT_MARGIN_MODE_RETAIL_HEDGING
name sring Yes account owner name
login number Yes account login
credit number Yes account credit in the deposit currency
accountCurrencyExchangeRate number current exchange rate of account currency into account base currency (USD if you did not override it)
type string Yes account type. enum ACCOUNT_TRADE_MODE_DEMO, ACCOUNT_TRADE_MODE_CONTEST, ACCOUNT_TRADE_MODE_REAL

Example#

{
  "broker": "True ECN Trading Ltd",
  "currency": "USD",
  "server": "ICMarketsSC-Demo",
  "balance": 7319.9,
  "equity": 7306.649913200001,
  "margin": 184.1,
  "freeMargin": 7120.22,
  "leverage": 100,
  "marginLevel": 3967.58283542,
  "tradeAllowed": true,
  "marginMode": "ACCOUNT_MARGIN_MODE_RETAIL_HEDGING",
  "name": "Will Turner",
  "login": 367906877,
  "credit": 0,
  "accountCurrencyExchangeRate": 1,
  "type": "ACCOUNT_TRADE_MODE_DEMO"
}

Usages#