The unique ID of the bonus deposit/withdrawal operation.
managerBonus
int64
Required
Total amount of broker's bonus after the operation.
managerDelta
int64
Required
Amount of bonus deposited/withdrew by manager.
ibBonus
int64
Required
Total amount of introducing broker's bonus after the operation.
ibDelta
int64
Required
Amount of bonus deposited/withdrew by introducing broker.
changeBonusTimestamp
int64
Required
The Unix time in milliseconds when the bonus operation was executed.
externalNote
string
Optional
Note added to operation. Visible to the trader.
introducingBrokerId
int64
Optional
ID of introducing broker who deposited/withdrew bonus.
moneyDigits
uint32
Optional
Specifies the exponent of the monetary values. E.g. moneyDigits = 8 must be interpret as business value multiplied by 10^8, then real balance would be 10053099944 / 10^8 = 100.53099944. Affects managerBonus, managerDelta, ibBonus, ibDelta.
Covers all cash movement operations related to account, trading, IB operations, mirroring, etc.
Name
Value
Description
BALANCE_DEPOSIT
0
Cash deposit.
BALANCE_WITHDRAW
1
Cash withdrawal.
BALANCE_DEPOSIT_STRATEGY_COMMISSION_INNER
3
Received mirroring commission.
BALANCE_WITHDRAW_STRATEGY_COMMISSION_INNER
4
Paid mirroring commission.
BALANCE_DEPOSIT_IB_COMMISSIONS
5
For IB account. Commissions paid by trader.
BALANCE_WITHDRAW_IB_SHARED_PERCENTAGE
6
For IB account. Withdrawal of commissions shared with broker.
BALANCE_DEPOSIT_IB_SHARED_PERCENTAGE_FROM_SUB_IB
7
For IB account. Commissions paid by sub-ibs.
BALANCE_DEPOSIT_IB_SHARED_PERCENTAGE_FROM_BROKER
8
For IB account. Commissions paid by broker.
BALANCE_DEPOSIT_REBATE
9
Deposit rebate for trading volume for period.
BALANCE_WITHDRAW_REBATE
10
Withdrawal of rebate.
BALANCE_DEPOSIT_STRATEGY_COMMISSION_OUTER
11
Mirroring commission.
BALANCE_WITHDRAW_STRATEGY_COMMISSION_OUTER
12
Mirroring commission.
BALANCE_WITHDRAW_BONUS_COMPENSATION
13
For IB account. Share commission with the Broker.
BALANCE_WITHDRAW_IB_SHARED_PERCENTAGE_TO_BROKER
14
IB commissions.
BALANCE_DEPOSIT_DIVIDENDS
15
Deposit dividends payments.
BALANCE_WITHDRAW_DIVIDENDS
16
Negative dividend charge for short position.
BALANCE_WITHDRAW_GSL_CHARGE
17
Fee charged for attaching a guaranteed stop loss to a position, taken when the guaranteed protective order is accepted, whether it comes from ProtoOANewOrderReq, ProtoOAAmendOrderReq or ProtoOAAmendPositionSLTPReq. Amount is the symbol's gslCharge rate times position volume, or times stake for spread betting. Not charged again when a protective order is recreated after the originating order fills, and not charged when the guaranteed stop loss triggers.
BALANCE_WITHDRAW_ROLLOVER
18
Charge of rollover fee for Shariah compliant accounts.
BALANCE_DEPOSIT_NONWITHDRAWABLE_BONUS
19
Broker's operation to deposit bonus.
BALANCE_WITHDRAW_NONWITHDRAWABLE_BONUS
20
Broker's operation to withdrawal bonus.
BALANCE_DEPOSIT_SWAP
21
Deposits of negative SWAP.
BALANCE_WITHDRAW_SWAP
22
SWAP charges.
BALANCE_DEPOSIT_MANAGEMENT_FEE
27
Mirroring commission.
BALANCE_WITHDRAW_MANAGEMENT_FEE
28
Mirroring commission. Deprecated since 7.1 in favor of BALANCE_WITHDRAW_COPY_FEE (34).
BALANCE_DEPOSIT_PERFORMANCE_FEE
29
Mirroring commission.
BALANCE_WITHDRAW_FOR_SUBACCOUNT
30
Withdraw for subaccount creation (cTrader Copy).
BALANCE_DEPOSIT_TO_SUBACCOUNT
31
Deposit to subaccount on creation (cTrader Copy).
BALANCE_WITHDRAW_FROM_SUBACCOUNT
32
Manual user's withdraw from subaccount (cTrader Copy), to parent account.
BALANCE_DEPOSIT_FROM_SUBACCOUNT
33
Manual user's deposit to subaccount (cTrader Copy), from parent account.
BALANCE_WITHDRAW_COPY_FEE
34
Withdrawal fees to Strategy Provider.
BALANCE_WITHDRAW_INACTIVITY_FEE
35
Withdraw of inactivity fee from the balance.
BALANCE_DEPOSIT_TRANSFER
36
Deposit within the same server (from another account).
BALANCE_WITHDRAW_TRANSFER
37
Withdraw within the same server (to another account).
BALANCE_DEPOSIT_CONVERTED_BONUS
38
Bonus being converted from virtual bonus to real deposit.
BALANCE_DEPOSIT_NEGATIVE_BALANCE_PROTECTION
39
Applies if negative balance protection is configured by broker, should make balance = 0.
Position price at the moment of filling the closing order.
grossProfit
int64
Required
Amount of realized gross profit after closing deal execution.
swap
int64
Required
Amount of realized swap related to closed volume.
commission
int64
Required
Amount of realized commission related to closed volume.
balance
int64
Required
Account balance after closing deal execution.
quoteToDepositConversionRate
double
Optional
Quote/Deposit currency conversion rate on the time of closing deal execution.
closedVolume
int64
Optional
Closed volume in cents.
balanceVersion
int64
Optional
Balance version of the account related to closing deal operation.
moneyDigits
uint32
Optional
Specifies the exponent of the monetary values. E.g. moneyDigits = 8 must be interpret as business value multiplied by 10^8, then real balance would be 10053099944 / 10^8 = 100.53099944. Affects grossProfit, swap, commission, balance, pnlConversionFee.
pnlConversionFee
int64
Optional
Fee for conversion applied to the Deal in account's ccy when trader symbol's quote asset id <> ProtoOATrader.depositAssetId.
Closing position detail. Valid only for closing deal.
moneyDigits
uint32
Optional
Specifies the exponent of the monetary values. E.g. moneyDigits = 8 must be interpret as business value multiplied by 10^8, then real balance would be 10053099944 / 10^8 = 100.53099944. Affects commission.
label
string
Optional
Label field value from corresponding order. Used by cAlgo bots to identify its own orders. Max length 100
The unique ID of the deposit/withdrawal operation.
balance
int64
Required
Account balance after the operation was executed.
delta
int64
Required
Amount of deposit/withdrawal operation.
changeBalanceTimestamp
int64
Required
The Unix time in milliseconds when deposit/withdrawal operation was executed.
externalNote
string
Optional
Note added to operation. Visible to the trader.
balanceVersion
int64
Optional
Balance version used to identify the final balance. Increments each time when the trader's account balance is changed.
equity
int64
Optional
Total account's equity after balance operation was executed.
moneyDigits
uint32
Optional
Specifies the exponent of the monetary values. E.g. moneyDigits = 8 must be interpret as business value multiplied by 10^8, then real balance would be 10053099944 / 10^8 = 100.53099944. Affects balance, delta, equity.
ID of the position linked to the order (e.g. closing order, order that increase volume of a specific position, etc.).
relativeStopLoss
int64
Optional
Relative stopLoss that can be specified instead of absolute as one. Specified in 1/100000 of unit of a price. (e.g. 123000 in protocol means 1.23, 53423782 means 534.23782) For BUY stopLoss = entryPrice - relativeStopLoss, for SELL stopLoss = entryPrice + relativeStopLoss.
relativeTakeProfit
int64
Optional
Relative takeProfit that can be specified instead of absolute one. Specified in 1/100000 of unit of a price. (e.g. 123000 in protocol means 1.23, 53423782 means 534.23782) ForBUY takeProfit = entryPrice + relativeTakeProfit, for SELL takeProfit = entryPrice - relativeTakeProfit.
isStopOut
bool
Optional
If TRUE then order was stopped out from server side.
trailingStopLoss
bool
Optional
If TRUE then order is trailingStopLoss. Valid for STOP_LOSS_TAKE_PROFIT order.
VWAP price of the position based on all executions (orders) linked to the position.
stopLoss
double
Optional
Current stop loss price.
takeProfit
double
Optional
Current take profit price.
utcLastUpdateTimestamp
int64
Optional
The Unix time in milliseconds of the last change of the position, including amend SL/TP of the position, execution of related order, cancel or related order, etc.
commission
int64
Optional
Current unrealized commission related to the position.
marginRate
double
Optional
Rate for used margin computation. Represented as Base/Deposit.
mirroringCommission
int64
Optional
Amount of unrealized commission related to following of strategy provider.
guaranteedStopLoss
bool
Optional
If TRUE then position's stop loss is guaranteedStopLoss.
usedMargin
uint64
Optional
Amount of margin used for the position in deposit currency.
Specifies the exponent of the monetary values. E.g. moneyDigits = 8 must be interpret as business value multiplied by 10^8, then real balance would be 10053099944 / 10^8 = 100.53099944. Affects swap, commission, mirroringCommission, usedMargin.
The unique identifier of the symbol in specific server environment within cTrader platform. Different servers have different IDs.
digits
int32
Required
Number of price digits to be displayed.
pipPosition
int32
Required
Pip position on digits.
enableShortSelling
bool
Optional
If TRUE then the short selling with the symbol is enabled.
guaranteedStopLoss
bool
Optional
If TRUE then guaranteed stop loss (GSL) orders are allowed for this symbol, i.e. the symbol's GSL execution policy is not DISABLED. Limited Risk accounts (ProtoOATrader.isLimitedRisk = true) must set guaranteedStopLoss on orders for such symbols.
Commission type. See ProtoOACommissionType for details.
slDistance
uint32
Optional
Minimum allowed distance between stop loss and current market price.
tpDistance
uint32
Optional
Minimum allowed distance between take profit and current market price.
gslDistance
uint32
Optional
Minimum allowed distance between guaranteed stop loss and current market price.
gslCharge
int64
Optional
Guaranteed stop loss charge rate, expressed in the unit given by distanceSetIn. In points mode it is a price distance per unit of volume: divide by 10^digits, then multiply by volume and the exchange rate (or by stake and 10^pipPosition for spread betting) to get the fee charged in the deposit currency. In percentage mode it is hundredths of a percent (100 means 1%), applied to the position price to get that same price distance, so the fee is that percent of the position value. Charged once, when the guaranteed protective order is accepted, and not when the guaranteed stop loss triggers.
Minimum commission Type. See ProtoOAMinCommissionType for details.
minCommissionAsset
string
Optional
Currency for minimum commission. (USD or quote currency).
rolloverCommission
int64
Optional
Administrative Fee, charged instead of Swaps if the Account is marked as a "Shariah Compliant (Swap Free)". The Administrative Fee is charged daily as USD per current open volume of Position in lots. The Account charged in the Deposit currency.
skipRolloverDays
int32
Optional
Initial period before the first rolloverCommission will be charged on the account.
Specifies type of SWAP computation as PIPS (0) or PERCENTAGE (1, annual, in percent).
lotSize
int64
Optional
Lot size of the Symbol (in cents).
preciseTradingCommissionRate
int64
Optional
Commission base amount. Total commission depends on commissionType: for non-percentage types it is multiplied by 10^8, for percentage of value commission type it is multiplied by 10^5.
preciseMinCommission
int64
Optional
Minimum commission amount per trade multiplied by 10^8.
List of holidays for this symbol specified by broker.
pnlConversionFeeRate
int32
Optional
Percentage (1 = 0.01%) of the realized Gross Profit, which will be paid by the Trader for any trade if the Quote Asset of the traded Symbol is not matched with the Deposit Asset.
Some whitelabel assigned to trader by broker at the moment of account creation.
registrationTimestamp
int64
Optional
The Unix timestamp in milliseconds of the account registration. Should be used as minimal date in historical data requests.
isLimitedRisk
bool
Optional
If TRUE then account is compliant to use specific margin calculation strategy. Such accounts are require to have guaranteed stop loss on all positions.
Special strategy used in margin calculations for this account (if account isLimitedRisk).
moneyDigits
uint32
Optional
Specifies the exponent of the monetary values. E.g. moneyDigits = 8 must be interpret as business value multiplied by 10^8, then real balance would be 10053099944 / 10^8 = 100.53099944. Affects balance, managerBonus, ibBonus, nonWithdrawableBonus.
fairStopOut
bool
Optional
If TRUE - Position is fully closed on Stop Out, if FALSE - smart (partial closing) Stop Out is applied, if unspecified - Stop Out format is determined by Broker.