ProtoOATrader
* Trading account entity.
Implements: IMessage<ProtoOATrader>, IMessage, IEquatable<ProtoOATrader>, IDeepCloneable<ProtoOATrader>, IBufferMessage
Properties
public ProtoOAAccessRights AccessRights { get; set; }value = protoOATrader.AccessRights
protoOATrader.AccessRights = valueAccess rights that an owner has to the account in cTrader platform. See ProtoOAAccessRights for details.
public ProtoOAAccountType AccountType { get; set; }value = protoOATrader.AccountType
protoOATrader.AccountType = valueAccount type: HEDGED, NETTED, etc.
public long Balance { get; set; }value = protoOATrader.Balance
protoOATrader.Balance = valueCurrent account balance.
public long BalanceVersion { get; set; }value = protoOATrader.BalanceVersion
protoOATrader.BalanceVersion = valueBalance version used to identify the final balance. Increments each time when the trader's account balance is changed.
public string BrokerName { get; set; }value = protoOATrader.BrokerName
protoOATrader.BrokerName = valueSome whitelabel assigned to trader by broker at the moment of account creation.
public long CtidTraderAccountId { get; set; }value = protoOATrader.CtidTraderAccountId
protoOATrader.CtidTraderAccountId = valueThe unique Trader's Account ID used to match the responses to the Trader's Account.
public long DepositAssetId { get; set; }value = protoOATrader.DepositAssetId
protoOATrader.DepositAssetId = valueDeposit currency of the account.
public bool FairStopOut { get; set; }value = protoOATrader.FairStopOut
protoOATrader.FairStopOut = valueIf 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.
public bool FrenchRisk { get; set; }value = protoOATrader.FrenchRisk
protoOATrader.FrenchRisk = valueIf TRUE then account is AMF compliant. Use isLimitedRisk and limitedRiskMarginCalculationStrategy.
public bool HasAccessRights { get; }value = protoOATrader.HasAccessRightsGets whether the "accessRights" field is set
public bool HasAccountType { get; }value = protoOATrader.HasAccountTypeGets whether the "accountType" field is set
public bool HasBalance { get; }value = protoOATrader.HasBalanceGets whether the "balance" field is set
public bool HasBalanceVersion { get; }value = protoOATrader.HasBalanceVersionGets whether the "balanceVersion" field is set
public bool HasBrokerName { get; }value = protoOATrader.HasBrokerNameGets whether the "brokerName" field is set
public bool HasCtidTraderAccountId { get; }value = protoOATrader.HasCtidTraderAccountIdGets whether the "ctidTraderAccountId" field is set
public bool HasDepositAssetId { get; }value = protoOATrader.HasDepositAssetIdGets whether the "depositAssetId" field is set
public bool HasFairStopOut { get; }value = protoOATrader.HasFairStopOutGets whether the "fairStopOut" field is set
public bool HasFrenchRisk { get; }value = protoOATrader.HasFrenchRiskGets whether the "frenchRisk" field is set
public bool HasIbBonus { get; }value = protoOATrader.HasIbBonusGets whether the "ibBonus" field is set
public bool HasIsLimitedRisk { get; }value = protoOATrader.HasIsLimitedRiskGets whether the "isLimitedRisk" field is set
public bool HasLeverageInCents { get; }value = protoOATrader.HasLeverageInCentsGets whether the "leverageInCents" field is set
public bool HasLimitedRiskMarginCalculationStrategy { get; }value = protoOATrader.HasLimitedRiskMarginCalculationStrategyGets whether the "limitedRiskMarginCalculationStrategy" field is set
public bool HasManagerBonus { get; }value = protoOATrader.HasManagerBonusGets whether the "managerBonus" field is set
public bool HasMaxLeverage { get; }value = protoOATrader.HasMaxLeverageGets whether the "maxLeverage" field is set
public bool HasMoneyDigits { get; }value = protoOATrader.HasMoneyDigitsGets whether the "moneyDigits" field is set
public bool HasNonWithdrawableBonus { get; }value = protoOATrader.HasNonWithdrawableBonusGets whether the "nonWithdrawableBonus" field is set
public bool HasRegistrationTimestamp { get; }value = protoOATrader.HasRegistrationTimestampGets whether the "registrationTimestamp" field is set
public bool HasStopOutStrategy { get; }value = protoOATrader.HasStopOutStrategyGets whether the "stopOutStrategy" field is set
public bool HasSwapFree { get; }value = protoOATrader.HasSwapFreeGets whether the "swapFree" field is set
public bool HasTotalMarginCalculationType { get; }value = protoOATrader.HasTotalMarginCalculationTypeGets whether the "totalMarginCalculationType" field is set
public bool HasTraderLogin { get; }value = protoOATrader.HasTraderLoginGets whether the "traderLogin" field is set
public long IbBonus { get; set; }value = protoOATrader.IbBonus
protoOATrader.IbBonus = valueAmount of introducing broker bonus allocated to the account.
public bool IsLimitedRisk { get; set; }value = protoOATrader.IsLimitedRisk
protoOATrader.IsLimitedRisk = valueIf TRUE then account is compliant to use specific margin calculation strategy. Such accounts are require to have guaranteed stop loss on all positions.
public uint LeverageInCents { get; set; }value = protoOATrader.LeverageInCents
protoOATrader.LeverageInCents = valueAccount leverage (e.g. If leverage = 1:50 then value = 5000).
public ProtoOALimitedRiskMarginCalculationStrategy LimitedRiskMarginCalculationStrategy { get; set; }value = protoOATrader.LimitedRiskMarginCalculationStrategy
protoOATrader.LimitedRiskMarginCalculationStrategy = valueSpecial strategy used in margin calculations for this account (if account isLimitedRisk).
public long ManagerBonus { get; set; }value = protoOATrader.ManagerBonus
protoOATrader.ManagerBonus = valueAmount of broker's bonus allocated to the account.
public uint MaxLeverage { get; set; }value = protoOATrader.MaxLeverage
protoOATrader.MaxLeverage = valueMaximum allowed leverage for the account. Used as validation when a Trader can change leverage value.
public uint MoneyDigits { get; set; }value = protoOATrader.MoneyDigits
protoOATrader.MoneyDigits = valueSpecifies 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.
public long NonWithdrawableBonus { get; set; }value = protoOATrader.NonWithdrawableBonus
protoOATrader.NonWithdrawableBonus = valueBroker's bonus that cannot be withdrew from the account as cash.
public long RegistrationTimestamp { get; set; }value = protoOATrader.RegistrationTimestamp
protoOATrader.RegistrationTimestamp = valueThe Unix timestamp in milliseconds of the account registration. Should be used as minimal date in historical data requests.
public ProtoOAStopOutStrategy StopOutStrategy { get; set; }value = protoOATrader.StopOutStrategy
protoOATrader.StopOutStrategy = valueThe Stop Out strategy that is used for this Trader. The Trader can change the value in the cTrader UI if this option is not disabled by the Broker
public bool SwapFree { get; set; }value = protoOATrader.SwapFree
protoOATrader.SwapFree = valueIf TRUE then account is Shariah compliant.
public ProtoOATotalMarginCalculationType TotalMarginCalculationType { get; set; }value = protoOATrader.TotalMarginCalculationType
protoOATrader.TotalMarginCalculationType = valueMargin computation type for the account (MAX, SUM, NET).
public long TraderLogin { get; set; }value = protoOATrader.TraderLogin
protoOATrader.TraderLogin = valueID of the account that is unique per server (Broker).
Methods
public void ClearAccessRights()protoOATrader.ClearAccessRights()Clears the value of the "accessRights" field
public void ClearAccountType()protoOATrader.ClearAccountType()Clears the value of the "accountType" field
public void ClearBalance()protoOATrader.ClearBalance()Clears the value of the "balance" field
public void ClearBalanceVersion()protoOATrader.ClearBalanceVersion()Clears the value of the "balanceVersion" field
public void ClearBrokerName()protoOATrader.ClearBrokerName()Clears the value of the "brokerName" field
public void ClearCtidTraderAccountId()protoOATrader.ClearCtidTraderAccountId()Clears the value of the "ctidTraderAccountId" field
public void ClearDepositAssetId()protoOATrader.ClearDepositAssetId()Clears the value of the "depositAssetId" field
public void ClearFairStopOut()protoOATrader.ClearFairStopOut()Clears the value of the "fairStopOut" field
public void ClearFrenchRisk()protoOATrader.ClearFrenchRisk()Clears the value of the "frenchRisk" field
public void ClearIbBonus()protoOATrader.ClearIbBonus()Clears the value of the "ibBonus" field
public void ClearIsLimitedRisk()protoOATrader.ClearIsLimitedRisk()Clears the value of the "isLimitedRisk" field
public void ClearLeverageInCents()protoOATrader.ClearLeverageInCents()Clears the value of the "leverageInCents" field
public void ClearLimitedRiskMarginCalculationStrategy()protoOATrader.ClearLimitedRiskMarginCalculationStrategy()Clears the value of the "limitedRiskMarginCalculationStrategy" field
public void ClearManagerBonus()protoOATrader.ClearManagerBonus()Clears the value of the "managerBonus" field
public void ClearMaxLeverage()protoOATrader.ClearMaxLeverage()Clears the value of the "maxLeverage" field
public void ClearMoneyDigits()protoOATrader.ClearMoneyDigits()Clears the value of the "moneyDigits" field
public void ClearNonWithdrawableBonus()protoOATrader.ClearNonWithdrawableBonus()Clears the value of the "nonWithdrawableBonus" field
public void ClearRegistrationTimestamp()protoOATrader.ClearRegistrationTimestamp()Clears the value of the "registrationTimestamp" field
public void ClearStopOutStrategy()protoOATrader.ClearStopOutStrategy()Clears the value of the "stopOutStrategy" field
public void ClearSwapFree()protoOATrader.ClearSwapFree()Clears the value of the "swapFree" field
public void ClearTotalMarginCalculationType()protoOATrader.ClearTotalMarginCalculationType()Clears the value of the "totalMarginCalculationType" field
public void ClearTraderLogin()protoOATrader.ClearTraderLogin()Clears the value of the "traderLogin" field
Fields
public const int AccessRightsFieldNumbervalue = ProtoOATrader.AccessRightsFieldNumberField number for the "accessRights" field.
public const int AccountTypeFieldNumbervalue = ProtoOATrader.AccountTypeFieldNumberField number for the "accountType" field.
public const int BalanceFieldNumbervalue = ProtoOATrader.BalanceFieldNumberField number for the "balance" field.
public const int BalanceVersionFieldNumbervalue = ProtoOATrader.BalanceVersionFieldNumberField number for the "balanceVersion" field.
public const int BrokerNameFieldNumbervalue = ProtoOATrader.BrokerNameFieldNumberField number for the "brokerName" field.
public const int CtidTraderAccountIdFieldNumbervalue = ProtoOATrader.CtidTraderAccountIdFieldNumberField number for the "ctidTraderAccountId" field.
public const int DepositAssetIdFieldNumbervalue = ProtoOATrader.DepositAssetIdFieldNumberField number for the "depositAssetId" field.
public const int FairStopOutFieldNumbervalue = ProtoOATrader.FairStopOutFieldNumberField number for the "fairStopOut" field.
public const int FrenchRiskFieldNumbervalue = ProtoOATrader.FrenchRiskFieldNumberField number for the "frenchRisk" field.
public const int IbBonusFieldNumbervalue = ProtoOATrader.IbBonusFieldNumberField number for the "ibBonus" field.
public const int IsLimitedRiskFieldNumbervalue = ProtoOATrader.IsLimitedRiskFieldNumberField number for the "isLimitedRisk" field.
public const int LeverageInCentsFieldNumbervalue = ProtoOATrader.LeverageInCentsFieldNumberField number for the "leverageInCents" field.
public const int LimitedRiskMarginCalculationStrategyFieldNumbervalue = ProtoOATrader.LimitedRiskMarginCalculationStrategyFieldNumberField number for the "limitedRiskMarginCalculationStrategy" field.
public const int ManagerBonusFieldNumbervalue = ProtoOATrader.ManagerBonusFieldNumberField number for the "managerBonus" field.
public const int MaxLeverageFieldNumbervalue = ProtoOATrader.MaxLeverageFieldNumberField number for the "maxLeverage" field.
public const int MoneyDigitsFieldNumbervalue = ProtoOATrader.MoneyDigitsFieldNumberField number for the "moneyDigits" field.
public const int NonWithdrawableBonusFieldNumbervalue = ProtoOATrader.NonWithdrawableBonusFieldNumberField number for the "nonWithdrawableBonus" field.
public const int RegistrationTimestampFieldNumbervalue = ProtoOATrader.RegistrationTimestampFieldNumberField number for the "registrationTimestamp" field.
public const int StopOutStrategyFieldNumbervalue = ProtoOATrader.StopOutStrategyFieldNumberField number for the "stopOutStrategy" field.
public const int SwapFreeFieldNumbervalue = ProtoOATrader.SwapFreeFieldNumberField number for the "swapFree" field.
public const int TotalMarginCalculationTypeFieldNumbervalue = ProtoOATrader.TotalMarginCalculationTypeFieldNumberField number for the "totalMarginCalculationType" field.
public const int TraderLoginFieldNumbervalue = ProtoOATrader.TraderLoginFieldNumberField number for the "traderLogin" field.