CPlugin
Log in

MT5 v2 :: Groups

API v2 (beta) · MT5 · 2 operations · base URL https://cloud.mywebapi.com · OpenAPI v2 (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.

Operations

Get a group by name

GET /api/v2/MT5/{tradePlatform}/GroupGet/{group}

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

NameInTypeRequiredDescription
tradePlatform path string (uuid) yes Trade platform identifier (GUID).
group path string yes Group name.
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.

Responses

Example

curl "https://cloud.mywebapi.com/api/v2/MT5/$TRADE_PLATFORM_ID/GroupGet/$GROUP" \
  -H "Authorization: Bearer $TOKEN"

Partially update a group

PATCH /api/v2/MT5/{tradePlatform}/GroupRecord/{group}

Send only the fields you want to change (JSON Merge Patch, RFC 7386); omitted fields keep their current values. Returns the updated record.

Timeout: 15 s by default, adjustable per request with the X-Request-Timeout header. When the trade server does not answer in time: The operation may still be completed by the server (X-Request-Outcome: unknown): check its result before repeating it.

Parameters

NameInTypeRequiredDescription
tradePlatform path string (uuid) yes Trade platform identifier (GUID).
group path string yes Group name.
X-Request-Timeout header number (double) no How long to wait for the trade server, in seconds (1–300). Default for this operation: 15 s (change). 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.

Request body

object (application/json, required) — JSON Merge Patch: an object with only the fields to change.

Responses

Example

curl -X PATCH "https://cloud.mywebapi.com/api/v2/MT5/$TRADE_PLATFORM_ID/GroupRecord/$GROUP" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

Schemas

Types the operations above take and return, with their first-level properties; * marks a required one. The full graph is in the OpenAPI specification.

MT5ConGroupApiResponse

Unified v2 response envelope: data is the payload (null on error); error is the error object (null on success, always serialised); meta contains response metadata (activityId and optional paging). HTTP status is always 200.

PropertyTypeDescription
data MT5ConGroup
error ApiError v2 error body. Code is the stable transport error code; ManagerCode is the raw MT4 ResultCode (serialized as a string for a known enum member, or as a number for an unrecognised value returned by MT4); Message is a human-readable description.
meta ApiMeta Response metadata. ActivityId is the W3C trace-id for correlation in Seq/SigNoz. Paging is present only on paginated list responses; otherwise it is omitted — the global JSON context policy serialises null fields, so we override that here with System.Text.Json.Serialization.JsonIgnoreCondition.WhenWritingNull.

MT5ConGroup

PropertyTypeDescription
group string, nullable group name
server integer (int64), nullable group trade server ID
permissionsFlags EnPermissionsFlags EnPermissionsFlags
authMode EnAuthMode EnAuthMode
authPasswordMin integer (int32), nullable minimal password length
company string, nullable company name
companyPage string, nullable company web page URL
companyEmail string, nullable company email
companySupportPage string, nullable company support site URL
companySupportEmail string, nullable company support email
companyCatalog string, nullable company catalog name (for reports and email templates)
currency string, nullable deposit currency
currencyDigits integer (int32), nullable
reportsMode EnReportsMode EnReportsMode
reportsFlags EnReportsFlags EnReportsFlags
reportsSMTP string, nullable reports SMTP server address:ports
reportsSMTPLogin string, nullable reports SMTP server login
reportsSMTPPass string, nullable reports SMTP server password
newsMode EnNewsMode EnNewsMode
newsCategory string, nullable news category filter string
newsLang integer (int32)[] 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)
mailMode EnMailMode EnMailMode
tradeFlags EnTradeRightsFlags EnTradeFlags
tradeInterestRate number (double), nullable interest rate for free deposit money
tradeVirtualCredit number (double), nullable virtual credit
marginFreeMode EnFreeMarginMode EnFreeMarginMode
marginSOMode EnStopOutMode EnStopOutMode
marginCall number (double), nullable Margin Call level value
marginStopOut number (double), nullable Sto-Out level value
demoLeverage integer (int32), nullable default demo accounts leverage
demoDeposit number (double), nullable default demo accounts deposit
limitHistory EnHistoryLimit EnHistoryLimit
limitOrders integer (int32), nullable max. order limit
limitSymbols integer (int32), nullable max. selected symbols limit
commissions map<string, MT5ConCommission> /// 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.
marginFreeProfitMode integer (int32), nullable margin free profit accounting mode
marginMode EnMarginMode group risk management mode - EnMarginMode
authOTPMode EnAuthOTPMode OTP authentication mode - EnAuthOTPMode
tradeTransferMode EnTransferMode deposit transfer mode - EnTransferMode
marginFlags EnMarginCalcFlags margin calculation flags EnMarginFlags
limitPositions integer (int32), nullable max. positions limit
reportsEmail string, nullable reports SMTP email account
companyDepositPage string, nullable company deposit URL
companyWithdrawalPage string, nullable company deposit URL
demoInactivityPeriod integer (int32), nullable demo groups in days, orders and positions will be deleted after this period

ApiError

v2 error body. Code is the stable transport error code; ManagerCode is the raw MT4 ResultCode (serialized as a string for a known enum member, or as a number for an unrecognised value returned by MT4); Message is a human-readable description.

PropertyTypeDescription
code WebApiErrorCode Stable transport-level error code.
managerCode ResultCode Raw MT4/MT5 manager result code, when the error came from the trading platform; otherwise null.
message string, nullable Human-readable error description.

ApiMeta

Response metadata. ActivityId is the W3C trace-id for correlation in Seq/SigNoz. Paging is present only on paginated list responses; otherwise it is omitted — the global JSON context policy serialises null fields, so we override that here with System.Text.Json.Serialization.JsonIgnoreCondition.WhenWritingNull.

PropertyTypeDescription
activityId string, nullable W3C trace id for correlating this response in logs and tracing (Seq/SigNoz).
paging PagingMeta Pagination info; present only on list responses, omitted otherwise.