ProtoOASymbol
* Trading symbol entity.
Implements: IMessage<ProtoOASymbol>, IMessage, IEquatable<ProtoOASymbol>, IDeepCloneable<ProtoOASymbol>, IBufferMessage
Properties
ChargeSwapAtWeekends : bool
If enabled, SWAP will be charged for all days of the week, including Saturday and Sunday.
Commission : long
Commission base amount. Total commission depends on commissionType. Use preciseTradingCommissionRate.
CommissionType : ProtoOACommissionType
Commission type. See ProtoOACommissionType for details.
DistanceSetIn : ProtoOASymbolDistanceType
Unit of distance measure for slDistance, tpDistance, gslDistance.
EnableShortSelling : bool
If TRUE then the short selling with the symbol is enabled.
GslDistance : uint
Minimum allowed distance between guaranteed stop loss and current market price.
GuaranteedStopLoss : bool
If TRUE then setting of guaranteedStopLoss is available for limited risk accounts.
HasChargeSwapAtWeekends : bool
Gets whether the "chargeSwapAtWeekends" field is set
HasCommission : bool
Gets whether the "commission" field is set
HasCommissionType : bool
Gets whether the "commissionType" field is set
HasDistanceSetIn : bool
Gets whether the "distanceSetIn" field is set
HasEnableShortSelling : bool
Gets whether the "enableShortSelling" field is set
HasGslCharge : bool
Gets whether the "gslCharge" field is set
HasGslDistance : bool
Gets whether the "gslDistance" field is set
HasGuaranteedStopLoss : bool
Gets whether the "guaranteedStopLoss" field is set
HasLeverageId : bool
Gets whether the "leverageId" field is set
HasLotSize : bool
Gets whether the "lotSize" field is set
HasMaxExposure : bool
Gets whether the "maxExposure" field is set
HasMaxVolume : bool
Gets whether the "maxVolume" field is set
HasMeasurementUnits : bool
Gets whether the "measurementUnits" field is set
HasMinCommission : bool
Gets whether the "minCommission" field is set
HasMinCommissionAsset : bool
Gets whether the "minCommissionAsset" field is set
HasMinCommissionType : bool
Gets whether the "minCommissionType" field is set
HasMinVolume : bool
Gets whether the "minVolume" field is set
HasPipPosition : bool
Gets whether the "pipPosition" field is set
HasPnlConversionFeeRate : bool
Gets whether the "pnlConversionFeeRate" field is set
HasPreciseMinCommission : bool
Gets whether the "preciseMinCommission" field is set
HasPreciseTradingCommissionRate : bool
Gets whether the "preciseTradingCommissionRate" field is set
HasRolloverCommission : bool
Gets whether the "rolloverCommission" field is set
HasRolloverCommission3Days : bool
Gets whether the "rolloverCommission3Days" field is set
HasScheduleTimeZone : bool
Gets whether the "scheduleTimeZone" field is set
HasSkipRolloverDays : bool
Gets whether the "skipRolloverDays" field is set
HasSkipSWAPPeriods : bool
Gets whether the "skipSWAPPeriods" field is set
HasSlDistance : bool
Gets whether the "slDistance" field is set
HasStepVolume : bool
Gets whether the "stepVolume" field is set
HasSwapCalculationType : bool
Gets whether the "swapCalculationType" field is set
HasSwapLong : bool
Gets whether the "swapLong" field is set
HasSwapPeriod : bool
Gets whether the "swapPeriod" field is set
HasSwapRollover3Days : bool
Gets whether the "swapRollover3Days" field is set
HasSwapShort : bool
Gets whether the "swapShort" field is set
HasSwapTime : bool
Gets whether the "swapTime" field is set
HasSymbolId : bool
Gets whether the "symbolId" field is set
HasTpDistance : bool
Gets whether the "tpDistance" field is set
HasTradingMode : bool
Gets whether the "tradingMode" field is set
Holiday : RepeatedField<ProtoOAHoliday>
List of holidays for this symbol specified by broker.
LeverageId : long
The unique identifier of dynamic leverage entity. https://help.ctrader.com/ctrader/trading/dynamic-leverage
MaxExposure : ulong
Value of max exposure per symbol, per account. Blocks execution if breached.
MeasurementUnits : string
Specifies the units in which the base Asset of the Symbol is denominated.
MinCommission : long
Minimum commission amount per trade. Use preciseMinCommission.
MinCommissionAsset : string
Currency for minimum commission. (USD or quote currency).
MinCommissionType : ProtoOAMinCommissionType
Minimum commission Type. See ProtoOAMinCommissionType for details.
PipPosition : int
Pip position on digits.
PnlConversionFeeRate : int
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.
PreciseMinCommission : long
Minimum commission amount per trade multiplied by 10^8.
PreciseTradingCommissionRate : long
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.
RolloverCommission : long
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.
RolloverCommission3Days : ProtoOADayOfWeek
Day of the week (in UTC) when Administrative Fee charge amount will be tripled. Applied only if RolloverChargePeriod = 0 or 1.
Schedule : RepeatedField<ProtoOAInterval>
Symbol trading interval, specified in seconds starting from SUNDAY 00:00 in specified time zone.
ScheduleTimeZone : string
Time zone for the symbol trading intervals.
SkipRolloverDays : int
Initial period before the first rolloverCommission will be charged on the account.
SkipSWAPPeriods : int
Count of swapPeriods before the first SWAP charge.
SlDistance : uint
Minimum allowed distance between stop loss and current market price.
StepVolume : long
Step of the volume in cents for an order.
SwapCalculationType : ProtoOASwapCalculationType
Specifies type of SWAP computation as PIPS (0) or PERCENTAGE (1, annual, in percent).
SwapPeriod : int
Period of charging swaps in hours. 24 means swaps will be charged 1 time per day, 12 - every 12 hours, 8 - every 8 hours, etc.
SwapRollover3Days : ProtoOADayOfWeek
Day of the week when SWAP charge amount will be tripled. Doesn't impact Rollover Commission.
SymbolId : long
The unique identifier of the symbol in specific server environment within cTrader platform. Different servers have different IDs.
TpDistance : uint
Minimum allowed distance between take profit and current market price.
TradingMode : ProtoOATradingMode
Rules for trading with the symbol. See ProtoOATradingMode for details.
Methods
ClearChargeSwapAtWeekends()
Clears the value of the "chargeSwapAtWeekends" field
ClearCommission()
Clears the value of the "commission" field
ClearCommissionType()
Clears the value of the "commissionType" field
ClearDigits()
Clears the value of the "digits" field
ClearDistanceSetIn()
Clears the value of the "distanceSetIn" field
ClearEnableShortSelling()
Clears the value of the "enableShortSelling" field
ClearGslCharge()
Clears the value of the "gslCharge" field
ClearGslDistance()
Clears the value of the "gslDistance" field
ClearGuaranteedStopLoss()
Clears the value of the "guaranteedStopLoss" field
ClearLeverageId()
Clears the value of the "leverageId" field
ClearLotSize()
Clears the value of the "lotSize" field
ClearMaxExposure()
Clears the value of the "maxExposure" field
ClearMaxVolume()
Clears the value of the "maxVolume" field
ClearMeasurementUnits()
Clears the value of the "measurementUnits" field
ClearMinCommission()
Clears the value of the "minCommission" field
ClearMinCommissionAsset()
Clears the value of the "minCommissionAsset" field
ClearMinCommissionType()
Clears the value of the "minCommissionType" field
ClearMinVolume()
Clears the value of the "minVolume" field
ClearPipPosition()
Clears the value of the "pipPosition" field
ClearPnlConversionFeeRate()
Clears the value of the "pnlConversionFeeRate" field
ClearPreciseMinCommission()
Clears the value of the "preciseMinCommission" field
ClearPreciseTradingCommissionRate()
Clears the value of the "preciseTradingCommissionRate" field
ClearRolloverCommission()
Clears the value of the "rolloverCommission" field
ClearRolloverCommission3Days()
Clears the value of the "rolloverCommission3Days" field
ClearScheduleTimeZone()
Clears the value of the "scheduleTimeZone" field
ClearSkipRolloverDays()
Clears the value of the "skipRolloverDays" field
ClearSkipSWAPPeriods()
Clears the value of the "skipSWAPPeriods" field
ClearSlDistance()
Clears the value of the "slDistance" field
ClearStepVolume()
Clears the value of the "stepVolume" field
ClearSwapCalculationType()
Clears the value of the "swapCalculationType" field
ClearSwapLong()
Clears the value of the "swapLong" field
ClearSwapPeriod()
Clears the value of the "swapPeriod" field
ClearSwapRollover3Days()
Clears the value of the "swapRollover3Days" field
ClearSwapShort()
Clears the value of the "swapShort" field
ClearSwapTime()
Clears the value of the "swapTime" field
ClearSymbolId()
Clears the value of the "symbolId" field
ClearTpDistance()
Clears the value of the "tpDistance" field
ClearTradingMode()
Clears the value of the "tradingMode" field
Fields
ChargeSwapAtWeekendsFieldNumber : int
Field number for the "chargeSwapAtWeekends" field.
CommissionFieldNumber : int
Field number for the "commission" field.
CommissionTypeFieldNumber : int
Field number for the "commissionType" field.
DigitsFieldNumber : int
Field number for the "digits" field.
DistanceSetInFieldNumber : int
Field number for the "distanceSetIn" field.
EnableShortSellingFieldNumber : int
Field number for the "enableShortSelling" field.
GslChargeFieldNumber : int
Field number for the "gslCharge" field.
GslDistanceFieldNumber : int
Field number for the "gslDistance" field.
GuaranteedStopLossFieldNumber : int
Field number for the "guaranteedStopLoss" field.
HolidayFieldNumber : int
Field number for the "holiday" field.
LeverageIdFieldNumber : int
Field number for the "leverageId" field.
LotSizeFieldNumber : int
Field number for the "lotSize" field.
MaxExposureFieldNumber : int
Field number for the "maxExposure" field.
MaxVolumeFieldNumber : int
Field number for the "maxVolume" field.
MeasurementUnitsFieldNumber : int
Field number for the "measurementUnits" field.
MinCommissionAssetFieldNumber : int
Field number for the "minCommissionAsset" field.
MinCommissionFieldNumber : int
Field number for the "minCommission" field.
MinCommissionTypeFieldNumber : int
Field number for the "minCommissionType" field.
MinVolumeFieldNumber : int
Field number for the "minVolume" field.
PipPositionFieldNumber : int
Field number for the "pipPosition" field.
PnlConversionFeeRateFieldNumber : int
Field number for the "pnlConversionFeeRate" field.
PreciseMinCommissionFieldNumber : int
Field number for the "preciseMinCommission" field.
PreciseTradingCommissionRateFieldNumber : int
Field number for the "preciseTradingCommissionRate" field.
RolloverCommission3DaysFieldNumber : int
Field number for the "rolloverCommission3Days" field.
RolloverCommissionFieldNumber : int
Field number for the "rolloverCommission" field.
ScheduleFieldNumber : int
Field number for the "schedule" field.
ScheduleTimeZoneFieldNumber : int
Field number for the "scheduleTimeZone" field.
SkipRolloverDaysFieldNumber : int
Field number for the "skipRolloverDays" field.
SkipSWAPPeriodsFieldNumber : int
Field number for the "skipSWAPPeriods" field.
SlDistanceFieldNumber : int
Field number for the "slDistance" field.
StepVolumeFieldNumber : int
Field number for the "stepVolume" field.
SwapCalculationTypeFieldNumber : int
Field number for the "swapCalculationType" field.
SwapLongFieldNumber : int
Field number for the "swapLong" field.
SwapPeriodFieldNumber : int
Field number for the "swapPeriod" field.
SwapRollover3DaysFieldNumber : int
Field number for the "swapRollover3Days" field.
SwapShortFieldNumber : int
Field number for the "swapShort" field.
SwapTimeFieldNumber : int
Field number for the "swapTime" field.
SymbolIdFieldNumber : int
Field number for the "symbolId" field.
TpDistanceFieldNumber : int
Field number for the "tpDistance" field.
TradingModeFieldNumber : int
Field number for the "tradingMode" field.