MT5 v2 :: Symbols

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 /api/v2/MT5/{tradePlatform}/SymbolGet/{symbol} — Get a symbol by name
PATCH /api/v2/MT5/{tradePlatform}/SymbolRecord/{symbol} — Partially update a symbol

Get a symbol by name

GET /api/v2/MT5/{tradePlatform}/SymbolGet/{symbol}

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 identifier (GUID).
symbol	path	string	yes	Symbol name, e.g. "EURUSD".
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

200 Success — MT5SymbolApiResponse

Example

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

Partially update a symbol

PATCH /api/v2/MT5/{tradePlatform}/SymbolRecord/{symbol}

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

Name	In	Type	Required	Description
tradePlatform	path	string (uuid)	yes	Trade platform identifier (GUID).
symbol	path	string	yes	Symbol name, e.g. "EURUSD".
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

200 Success — MT5SymbolApiResponse

Example

curl -X PATCH "https://cloud.mywebapi.com/api/v2/MT5/$TRADE_PLATFORM_ID/SymbolRecord/$SYMBOL" \
  -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.

MT5SymbolApiResponse

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.

Property	Type	Description
data	MT5Symbol
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.

MT5Symbol

Property	Type	Description
symbol	string, nullable	name
path	string, nullable	hierarchical symbol path (including symbol name)
isin	string, nullable	ISIN
description	string, nullable	local description
international	string, nullable	internation description
basis	string, nullable	basic symbol name
source	string, nullable	source symbol name
page	string, nullable	symbol specification page URL
currencyBase	string, nullable	symbol base currency
currencyBaseDigits	integer (int32), nullable	Has No Setter In ManagerAPI, so all you can is to read this value.
currencyProfit	string, nullable	symbol profit currency
currencyProfitDigits	integer (int32), nullable	Has No Setter In ManagerAPI, so all you can is to read this value.
currencyMargin	string, nullable	symbol margin currency
currencyMarginDigits	integer (int32), nullable	Has No Setter In ManagerAPI, so all you can is to read this value.
color	integer (int32), nullable	symbol color
colorBackground	integer (int32), nullable	symbol background color
digits	integer (int32), nullable	symbol digits
point	number (double), nullable
multiply	number (double), nullable	Has No Setter In ManagerAPI, so all you can is to read this value.
tickFlags	EnTickFlags	EnTickFlags
tickBookDepth	integer (int32), nullable	Depth of Market depth (both legs)
filterSoft	integer (int32), nullable	filtration soft level
filterSoftTicks	integer (int32), nullable	filtration soft level counter
filterHard	integer (int32), nullable	filtration hard level
filterHardTicks	integer (int32), nullable	filtration hard level counter
filterDiscard	integer (int32), nullable	filtration discard level
filterSpreadMax	integer (int32), nullable	spread max value
filterSpreadMin	integer (int32), nullable	spread min value
tradeMode	EnTradeMode	EnTradeMode
calcMode	EnCalcMode	EnCalcMode
execMode	EnExecutionMode	EnExecutionMode
gtcMode	EnGtcMode	EnGTCMode
fillFlags	EnFillingFlags	EnFillingFlags
expirFlags	EnExpirationFlags	EnExpirationFlags
spread	integer (int32), nullable	symbol spread (0-floating)
spreadBalance	integer (int32), nullable	spread balance
spreadDiff	integer (int32), nullable	spread difference
spreadDiffBalance	integer (int32), nullable	spread difference balance
tickValue	number (double), nullable	tick value
tickSize	number (double), nullable	tick size
contractSize	number (double), nullable	contract size
stopsLevel	integer (int32), nullable	stops level
freezeLevel	integer (int32), nullable	freeze level
quotesTimeout	integer (int32), nullable	The time to wait for quotes in seconds, after which trading is automatically disabled for the symbol.
volumeMin	integer (int64), nullable	minimal volume
volumeMax	integer (int64), nullable	maximal volume
volumeStep	integer (int64), nullable	volume step
volumeLimit	integer (int64), nullable	cumulative positions and orders limit
marginFlags	EnMarginFlags	EnMarginFlags
marginInitial	number (double), nullable	initial margin
marginMaintenance	number (double), nullable	maintenance margin
marginLong	number (double), nullable	long orders and positions margin rate
marginShort	number (double), nullable	short orders and positions margin rate
marginLimit	number (double), nullable	limit orders and positions margin rate
marginStop	number (double), nullable	stop orders and positions margin rate
marginStopLimit	number (double), nullable	stop-limit orders and positions margin rate
swapMode	EnSwapMode	EnSwapMode
swapLong	number (double), nullable	long positions swaps rate
swapShort	number (double), nullable	short positions swaps rate
swap3Day	EnSwapDays	3 time swaps day, EnSwapDay
timeStart	string (date-time), nullable	trade start date
timeExpiration	string (date-time), nullable	The date of trading expiration for a symbol. It is considered that there is no time limitation for trading by a symbol if both IMTConSymbol::TimeStart and IMTConSymbol::TimeExpiration are equal to 0.
sessionQuote	MT5SymbolSession[][]	Not yet implemented. Contact us for further information Update a quoting session of a symbol by the day and index. The day is specified by a value 0 (Sunday) to 6 (Saturday).
sessionTrade	MT5SymbolSession[][]	Not yet implemented. Contact us for further information
reFlags	EnRequestFlags	request execution flags
reTimeout	integer (int32), nullable	Time in seconds during which the price issued by a dealer in the request execution mode is valid.
ieCheckMode	EnInstantMode	instant execution check mode
ieTimeout	integer (int32), nullable	Get and set the maximum allowed difference between the time of arrival of the price, at which the client places an order, and the time of the last price.
ieSlipProfit	integer (int32), nullable	instant execution profit slippage
ieSlipLosing	integer (int32), nullable	instant execution losing slippage
ieVolumeMax	integer (int64), nullable	instant execution max volume
priceSettle	number (double), nullable	settle price (for futures)
priceLimitMax	number (double), nullable	price limit max (for futures)
priceLimitMin	number (double), nullable	price limit min (for futures)
tradeFlags	EnTradeFlags	EnTradeFlags
orderFlags	EnOrderFlags	EnOrderFlags
marginRateInitial	object, nullable	orders and positions margin rates
marginRateMaintenance	object, nullable	orders and positions margin rates
optionsMode	EnOptionMode	options mode EnOptionMode
priceStrike	number (double), nullable	option strike price value

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.

Property	Type	Description
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.

Property	Type	Description
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.