API v1 (stable) · MT5 · 3 operations ·
base URL https://cloud.mywebapi.com ·
OpenAPI v1 (JSON) ·
Redoc
Every call needs Authorization: Bearer $TOKEN — an OAuth 2.0 client-credentials token from
https://auth.cplugin.net/connect/token (scope webapi).
$TRADE_PLATFORM_ID is the id of a trade platform registered in Toolbox.
Timeout: 10 s by default, adjustable per request with the X-Request-Timeout header. When the trade server does not answer in time: Nothing was changed; the request is safe to repeat.
Parameters
Name
In
Type
Required
Description
tradePlatform
path
string (uuid)
yes
Trade platform id
group
path
string
yes
Name of the configuration
X-Request-Timeout
header
number (double)
no
How long to wait for the trade server, in seconds (1–300). Default for this operation: 10 s (read). The query parameter requestTimeout does the same for clients that cannot set headers. The applied value is returned in the X-Request-Timeout-Applied response header.
Timeout: 10 s by default, adjustable per request with the X-Request-Timeout header. When the trade server does not answer in time: Nothing was changed; the request is safe to repeat.
Parameters
Name
In
Type
Required
Description
tradePlatform
path
string (uuid)
yes
Trade platform id
group
path
string
yes
Name of the configuration
X-Request-Timeout
header
number (double)
no
How long to wait for the trade server, in seconds (1–300). Default for this operation: 10 s (read). The query parameter requestTimeout does the same for clients that cannot set headers. The applied value is returned in the X-Request-Timeout-Applied response header.
GET /api/MT5/{tradePlatform}/GroupRequestArray/{mask}
Timeout: 10 s by default, adjustable per request with the X-Request-Timeout header. When the trade server does not answer in time: Nothing was changed; the request is safe to repeat.
Parameters
Name
In
Type
Required
Description
tradePlatform
path
string (uuid)
yes
Trade platform id
mask
path
string
yes
One or more groups separated by commas. Specify the full name of the group, including the path. For example, demo\demoforex. The group name can be obtained using the IMTConGroup::Group method. Groups can also be specified using wildcard characters: "*" (any value) and "!" (exclude). For example: "demo*,!demoforex" — all groups whose names begin with 'demo', except for the group demoforex.
X-Request-Timeout
header
number (double)
no
How long to wait for the trade server, in seconds (1–300). Default for this operation: 10 s (read). The query parameter requestTimeout does the same for clients that cannot set headers. The applied value is returned in the X-Request-Timeout-Applied response header.
Setter not yet implemented. If you want to send this value to MT5, ask vendor to implement this feature. Exception will be thrown if you send anything but null here. allowed news languages (Windows API LANGID used)
/// Setter not yet implemented. If you want to send this value to MT5, ask vendor to implement this feature. Exception will be thrown if you send anything but null here.
demo groups in days, orders and positions will be deleted after this period
EnPermissionsFlags
Flags: names of the set bits joined by ", " ("CertConfirm, EnableConnection"), "None" when none is set; a set bit without a name is "Bit<n>" (bit number). Bits: CertConfirm = 0x1, EnableConnection = 0x2, ResetPassword = 0x4, ForcedOtpUsage = 0x8, RiskWarning = 0x10, RegulationProtect = 0x20, NotifyDeals = 0x40, NotifyOrders = 0x80, NotifyBalances = 0x100. Accepted on input, never written: NotifyAll = NotifyDeals, NotifyOrders, NotifyBalances; All = CertConfirm, EnableConnection, ResetPassword, ForcedOtpUsage, RiskWarning, RegulationProtect, NotifyDeals, NotifyOrders, NotifyBalances.
EnAuthMode
Values: Standard, Rsa1024, Rsa2048, RsaCustom
EnReportsMode
Values: Disabled, Full, EODOnly, EOMOnly
EnReportsFlags
Flags: names of the set bits joined by ", " ("Email, Support"), "None" when none is set; a set bit without a name is "Bit<n>" (bit number). Bits: Email = 0x1, Support = 0x2, Statements = 0x4. Accepted on input, never written: All = Email, Statements.
EnNewsMode
Values: Disabled, Headers, Full
EnMailMode
Values: Disabled, Full
EnTradeRightsFlags
Flags: names of the set bits joined by ", " ("Swaps, Trailing"), "None" when none is set; a set bit without a name is "Bit<n>" (bit number). Bits: Swaps = 0x1, Trailing = 0x2, Experts = 0x4, Expiration = 0x8, SignalsAll = 0x10, SignalsOwn = 0x20, SOCompensation = 0x40, SOFullyHedged = 0x80, FifoClose = 0x100, HedgeProhibit = 0x200, DealCost = 0x400, SOCompensationCredit = 0x800. Accepted on input, never written: Default = Swaps, Trailing, Experts, Expiration, SignalsAll; All = Swaps, Trailing, Experts, Expiration, SignalsAll, SignalsOwn, SOCompensation, SOFullyHedged, FifoClose, HedgeProhibit, DealCost, SOCompensationCredit.
EnFreeMarginMode
Values: NotUsePL, UsePL, Profit, Loss
EnStopOutMode
Values: Percent, Money
EnHistoryLimit
Values: All, Months1, Months3, Months6, Year1, Year2, Year3
MT5ConCommission
Property
Type
Description
name
string, nullable
commission name
description
string, nullable
description
path
string, nullable
symbols path
mode
EnCommMode
EnCommMode
rangeMode
EnCommRangeMode
EnCommRangeMode
chargeMode
EnCommChargeMode
EnCommChargeMode
tiers
MT5ConCommTier[]
commission tiers. Index in array from 0 means Position of the range.
Flags: names of the set bits joined by ", " ("ClearAcc"), "None" when none is set; a set bit without a name is "Bit<n>" (bit number). Bits: ClearAcc = 0x1.
