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
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 Yes Margin level calculated as % of equity/margin
tradeAllowed boolean Yes Flag indicating that trading is allowed
marginMode string Yes Margin calculation mode, enum: ACCOUNT_MARGIN_MODE_EXCHANGE, ACCOUNT_MARGIN_MODE_RETAIL_NETTING, ACCOUNT_MARGIN_MODE_RETAIL_HEDGING
name string Yes Account owner name
login string Yes Account login
credit number Yes Account credit in the deposit currency

Example#

{
  "platform": "mt4", 
  "broker": "True ECN Trading Ltd", 
  "currency": "USD",
  "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": 12345,
  "credit": 0,
}

Usages#