Skip to content

Accounts (table)

Overview

This section describes the Accounts table that contains the trading account data such as funds used in trading, idle funds, profits/losses, certain account limitations, and so on.

Name Type Description
AccountID String The unique identification number of an account. The number is unique within the database where the
account is stored. For example, MINIDEMO or U100D1. The uniqueness of the account itself is assured by
the combination of the database ID and the value of this field.

Note: In the field labeled "Account", the application displays the value of the AccountName field (for example, 00286255).
This value is not equal to the value of the AccountID field (for example 286255). Therefore, do not use the AccountName field when the
actual AccountID field is required!
AccountName String The unique name of the account as it is displayed in the the application. The name is unique within
the database where the account is stored. For example, MINIDEMO or U100D1. The uniqueness of the
account itself is assured by the combination of the database ID and the value of this field.
Balance Double The amount of funds on the account. This amount does not include floating profit and loss.
It is expressed in the account currency.
NonTradeEquity Double The amount of accounting transactions that is applied to the account during the current
trading day. In other words, this amount is a part of the equity balance that reflects non-trading
activity. It is expressed in the account currency and used for calculation of DayPL.
The accounting transactions are: deposit, withdrawal and funds transfer. A trading day is from 17:00 until 17:00 the next day Eastern Time (UTC-5).
If there are no accounting transactions during the current trading day, the value of this field is 0.0.
M2MEquity Double The equity balance of the account at the beginning of a trading day. It is expressed in the account currency and
used for calculation of DayPL. A trading day is from 17:00 until 17:00 the next day Eastern Time (UTC-5).
UsedMargin Double The amount of funds used to maintain all open positions on the account. It is expressed in
the account currency. If there are no open positions on the account, the value of this field is 0.0.
UsedMargin3 Double The amount of funds used to maintain all open positions on the account with the three-level
margin policy. It is expressed in the account currency. If there are no open positions on the account, the value of this field is 0.0.
AccountKind String The type of the account. The possible values are:


32Self-traded account, funds manager account (only LAMM), managed account (only LAMM).

36Funds manager account (only PAMM).

38Managed account (only PAMM).
MarginCallFlag String The limitation state of the account. Each state defines the operations that can be performed on the
account. The possible values are:

YMargin call (all positions are liquidated, new positions cannot be opened).

WWarning of a possible margin call (positions may be closed, new positions cannot be opened).

QEquity stop (all positions are liquidated, new positions cannot be opened up to the end ofthe trading day).

AEquity alert (positions may be closed, new positions cannot be opened up to the end of thetrading day).

NNo limitations (no limitations are imposed on the account operations).
LastMarginCallDate Date The date and time of the last occurrence of a Margin Call. If the account has never been in the Margin call limitation state, the value of this field is null.
MaintenanceType String The type of the position maintenance. It defines how trade operations can be performed on the
account. The possible values are:

YHedging is allowed. In other words, both buy and sell positions can be opened forthe same instrument at the same time. To close each buy or sell position, an individualorder is required.

NHedging is not allowed. In other words, either a buy or a sell position can be opened forthe same instrument at a time. Opening a position for the instrument that already hasopen position(s) of the opposite trade operation always causes closing or partial closing of the open position(s).

0Netting only. In other words, for each instrument there exists only one open position.The amount of the position is the total amount of the instrument, either bought or sold,that has not yet been offset by opposite trade operations.

DDay netting. In other words, for each instrument there exists only one open position.Same as Netting only, but within a trading day. If the position is not offset during the same trading day it is opened,it is closed automatically on simulated delivery date (see ValueDate field in the Offers table).

FFIFO. Positions open and close in accordance with the FIFO (First-in, First-out) rule. Hedging is not allowed.
AmountLimit Integer The maximum amount of an order that is allowed on the account.
It is expressed in the base currency of the instrument. For example, if the value is 30000, the maximum
amount of an order for EUR/USD is 30,000 Euro, for USD/JPY - 30,000 U.S. dollars, and so on.
If there are no restrictions on the maximum amount of an order, the value of this field is 0.
BaseUnitSize Integer The size of one lot. In other words, the minimum amount of a position that is allowed on the account.
It is expressed in the base currency of the instrument. For example, if the value is 1000, one lot for
EUR/USD is 1,000 Euro, for USD/JPY - 1,000 U.S. dollars, and so on. The total amount of a position must
be a whole number of lots. It is applicable only for FX instruments. This field is used for information purposes only.
The value for all instruments must be obtained from getBaseUnitSize method of the TradingSettingsProvider object.
MaintenanceFlag Boolean The rollover maintenance flag. It defines whether the account is under a rollover maintenance or not. The possible values are:

trueThe account is under a rollover maintenance.

falseThe account is not under a rollover maintenance.

It is applicable only for funds manager accounts (see AccountKind field above). For all other account types, the value of this field is false.
ManagerAccountID String The unique identification number of the funds manager account.
The number is unique within the database where the account is stored. For example, MINIDEMO or U100D1. The uniqueness of the funds manager
account itself is assured by the combination of the database ID and the value of this field.

It is applicable only for managed accounts. For all other account types, the value of this field is blank.
LeverageProfileID String The unique identification number of the account leverage profile which defines the margin requirements.
DayPL Double The amount of profits and losses (both floating and realized) of the current trading day. It is expressed in the account currency. A trading day is from
17:00 until 17:00 the next day Eastern Time (UTC-5).

Note: This is a calculable field, which is calculated on the client side.
Equity Double The amount of funds on the account, including profits and losses of all open positions (the floating
balance of the account). It is expressed in the account currency.

Note: This is a calculable field, which is calculated on the client side.
GrossPL Double The amount of profits and losses of all open positions on the account. It is expressed in the account currency. The GrossPL equals the difference between the Equity and the Balance of the
account.

Note: This is a calculable field, which is calculated on the client side.
UsableMargin Double The amount of funds available to open new positions or to absorb losses of the existing positions. It is expressed in the account currency. Once the UsableMargin
reaches zero, the margin call order is triggered for the account and the positions are automatically liquidated at the best
available price. Added together, the UsableMargin and UsedMargin make up the Equity of the account.

Note: This is a calculable field, which is calculated on the client side.
ATPID String The unique identification number of the account trading profile which defines the commission requirements.
Table of Contents