CPlugin
Log in

API v2 reference (beta)

JSON-Pure WebAPI for MT4/MT5, version 2.0 — 159 operations: MT4 147, MT5 12.

Uses the native MetaQuotes Manager API to connect to MT4 and MT5 trade servers and keeps a pumping connection open, so the …Get calls answer from it much faster than the …Request calls.

Partly follows the JSON-Pure API idea: a successful call answers HTTP 200; any other code reports an error, such as wrong parameters or an unavailable trade platform.

Base URL https://cloud.mywebapi.com · OpenAPI v2 specification (JSON) · interactive reference (Redoc)

MT4 v2 :: Authentication

POST /api/v2/MT4/{tradePlatform}/UserPasswordCheck/{login} Verify account password
POST /api/v2/MT4/{tradePlatform}/UserPasswordSet/{login} Set account password

MT4 v2 :: Backup

GET /api/v2/MT4/{tradePlatform}/BackupInfoUsers/{mode} List user backup files
GET /api/v2/MT4/{tradePlatform}/BackupInfoOrders/{mode} List order backup files
GET /api/v2/MT4/{tradePlatform}/BackupRequestUsers/{file} Read users from backup
GET /api/v2/MT4/{tradePlatform}/BackupRequestOrders/{file} Read orders from backup

MT4 v2 :: Backup (destructive)

POST /api/v2/MT4/{tradePlatform}/BackupRestoreUsers Restore users from backup
POST /api/v2/MT4/{tradePlatform}/BackupRestoreOrders Restore orders from backup

MT4 v2 :: Common

GET /api/v2/MT4/{tradePlatform}/ServerTime Get server time
GET /api/v2/MT4/{tradePlatform}/ManagerCommon Get manager common settings
GET /api/v2/MT4/{tradePlatform}/JournalRequest Get server journal

MT4 v2 :: Config

GET /api/v2/MT4/{tradePlatform}/CfgRequestCommon Get common config (live)
POST /api/v2/MT4/{tradePlatform}/CfgUpdateCommon Update common config
GET /api/v2/MT4/{tradePlatform}/CfgRequestHoliday List holiday config
GET /api/v2/MT4/{tradePlatform}/CfgRequestManager List manager configs
GET /api/v2/MT4/{tradePlatform}/CfgRequestTime Get access-hour matrix
POST /api/v2/MT4/{tradePlatform}/CfgUpdateTime Update access-hour matrix
GET /api/v2/MT4/{tradePlatform}/CfgRequestAccess List IP firewall rules
GET /api/v2/MT4/{tradePlatform}/CfgRequestBackup Get backup config
POST /api/v2/MT4/{tradePlatform}/CfgUpdateBackup Update backup config
POST /api/v2/MT4/{tradePlatform}/CfgUpdateSync Update sync rule
POST /api/v2/MT4/{tradePlatform}/CfgUpdateFeeder Update feeder config
POST /api/v2/MT4/{tradePlatform}/CfgUpdateGatewayAccount Update gateway account
POST /api/v2/MT4/{tradePlatform}/CfgUpdateGatewayMarkup Update gateway markup
POST /api/v2/MT4/{tradePlatform}/CfgUpdateGatewayRule Update gateway rule
POST /api/v2/MT4/{tradePlatform}/CfgUpdateLiveUpdate Update LiveUpdate config
POST /api/v2/MT4/{tradePlatform}/CfgUpdateManager Update manager config
POST /api/v2/MT4/{tradePlatform}/CfgUpdateAccess/{pos} Update IP firewall rule
POST /api/v2/MT4/{tradePlatform}/CfgUpdateDataServer/{pos} Update data-server entry
POST /api/v2/MT4/{tradePlatform}/CfgUpdateHoliday/{pos} Update holiday entry
POST /api/v2/MT4/{tradePlatform}/CfgUpdateSymbolGroup/{pos} Update symbol group
GET /api/v2/MT4/{tradePlatform}/CfgRequestGatewayAccount List gateway accounts
GET /api/v2/MT4/{tradePlatform}/CfgRequestGatewayMarkup List gateway markups
GET /api/v2/MT4/{tradePlatform}/CfgRequestGatewayRule List gateway rules
GET /api/v2/MT4/{tradePlatform}/CfgRequestDataServer List data servers
GET /api/v2/MT4/{tradePlatform}/CfgRequestFeeder List feeder configs
GET /api/v2/MT4/{tradePlatform}/CfgRequestLiveUpdate List LiveUpdate configs
GET /api/v2/MT4/{tradePlatform}/CfgRequestSync List sync rules
POST /api/v2/MT4/{tradePlatform}/CfgDeleteAccess/{pos} Delete IP firewall rule
POST /api/v2/MT4/{tradePlatform}/CfgDeleteDataServer/{pos} Delete data-server entry
POST /api/v2/MT4/{tradePlatform}/CfgDeleteFeeder/{pos} Delete feeder config
POST /api/v2/MT4/{tradePlatform}/CfgDeleteGatewayAccount/{pos} Delete gateway account
POST /api/v2/MT4/{tradePlatform}/CfgDeleteGatewayMarkup/{pos} Delete gateway markup
POST /api/v2/MT4/{tradePlatform}/CfgDeleteGatewayRule/{pos} Delete gateway rule
POST /api/v2/MT4/{tradePlatform}/CfgDeleteHoliday/{pos} Delete holiday entry
POST /api/v2/MT4/{tradePlatform}/CfgDeleteLiveUpdate/{pos} Delete LiveUpdate config
POST /api/v2/MT4/{tradePlatform}/CfgDeleteManager/{pos} Delete manager config
POST /api/v2/MT4/{tradePlatform}/CfgDeleteSymbol/{pos} Delete symbol config
POST /api/v2/MT4/{tradePlatform}/CfgDeleteSync/{pos} Delete sync rule
POST /api/v2/MT4/{tradePlatform}/CfgShiftAccess/{pos} Reorder IP firewall rule
POST /api/v2/MT4/{tradePlatform}/CfgShiftDataServer/{pos} Reorder data-server entry
POST /api/v2/MT4/{tradePlatform}/CfgShiftFeeder/{pos} Reorder feeder config
POST /api/v2/MT4/{tradePlatform}/CfgShiftGatewayAccount/{pos} Reorder gateway account
POST /api/v2/MT4/{tradePlatform}/CfgShiftGatewayMarkup/{pos} Reorder gateway markup
POST /api/v2/MT4/{tradePlatform}/CfgShiftGatewayRule/{pos} Reorder gateway rule
POST /api/v2/MT4/{tradePlatform}/CfgShiftGroup/{pos} Reorder trading group
POST /api/v2/MT4/{tradePlatform}/CfgShiftHoliday/{pos} Reorder holiday entry
POST /api/v2/MT4/{tradePlatform}/CfgShiftLiveUpdate/{pos} Reorder LiveUpdate config
POST /api/v2/MT4/{tradePlatform}/CfgShiftManager/{pos} Reorder manager config
POST /api/v2/MT4/{tradePlatform}/CfgShiftPlugin/{pos} Reorder plugin entry
POST /api/v2/MT4/{tradePlatform}/CfgShiftSymbol/{pos} Reorder symbol entry
POST /api/v2/MT4/{tradePlatform}/CfgShiftSync/{pos} Reorder sync rule

MT4 v2 :: Groups

GET /api/v2/MT4/{tradePlatform}/GroupsGet List trading groups (cached)
GET /api/v2/MT4/{tradePlatform}/GroupRecordGet/{group} Get trading group (cached)
GET /api/v2/MT4/{tradePlatform}/GroupsRequest List trading groups (live)
GET /api/v2/MT4/{tradePlatform}/GroupSecGroupsGet/{group} Get group security entries
GET /api/v2/MT4/{tradePlatform}/GroupSecMarginsGet/{group} Get group margin overrides
POST /api/v2/MT4/{tradePlatform}/GroupRecordUpdate/{group} Update trading group
PATCH /api/v2/MT4/{tradePlatform}/GroupRecord/{group} Patch trading group
GET /api/v2/MT4/{tradePlatform}/EnsureGroupNameExist/{group} Check group exists

MT4 v2 :: History

GET /api/v2/MT4/{tradePlatform}/TradesUserHistory/{login} Get account trade history

MT4 v2 :: Mail

GET /api/v2/MT4/{tradePlatform}/MailLast Get last mail path

MT4 v2 :: Margins

GET /api/v2/MT4/{tradePlatform}/MarginsGet List account margins (cached)
GET /api/v2/MT4/{tradePlatform}/MarginLevelGet/{login} Get account margin (cached)
GET /api/v2/MT4/{tradePlatform}/MarginLevelRequest/{login} Get account margin (live)

MT4 v2 :: News

GET /api/v2/MT4/{tradePlatform}/NewsTotal Get news count
GET /api/v2/MT4/{tradePlatform}/NewsBodyGet/{key} Get news body (cached)
GET /api/v2/MT4/{tradePlatform}/NewsGet List news headers
GET /api/v2/MT4/{tradePlatform}/NewsTopicGet/{pos} Get news header by index
POST /api/v2/MT4/{tradePlatform}/NewsBodyRequest/{key} Request news body fetch

MT4 v2 :: Online

GET /api/v2/MT4/{tradePlatform}/OnlineGet List online users (cached)
GET /api/v2/MT4/{tradePlatform}/OnlineRequest List online sessions (live)

MT4 v2 :: Plugins

POST /api/v2/MT4/{tradePlatform}/ExternalCommandJSON Send plugin command (JSON)

MT4 v2 :: Prices

GET /api/v2/MT4/{tradePlatform}/ChartRequest/{symbol} Get chart bars
POST /api/v2/MT4/{tradePlatform}/ChartAdd/{symbol} Add chart bars
POST /api/v2/MT4/{tradePlatform}/ChartUpdate/{symbol} Update chart bars
POST /api/v2/MT4/{tradePlatform}/ChartDelete/{symbol} Delete chart bars
POST /api/v2/MT4/{tradePlatform}/HistoryCorrect/{symbol} Repair chart history
GET /api/v2/MT4/{tradePlatform}/TicksRequest/{symbol} Get historical ticks
GET /api/v2/MT4/{tradePlatform}/TickInfoLast/{symbol} Get last tick (cached)
GET /api/v2/MT4/{tradePlatform}/TickInfoLast Get last ticks, all symbols (cached)

MT4 v2 :: Reports

GET /api/v2/MT4/{tradePlatform}/PerformanceRequest Get server performance series
GET /api/v2/MT4/{tradePlatform}/ReportsRequest Get closed-trade reports
GET /api/v2/MT4/{tradePlatform}/DailyReportsRequest Get daily reports
GET /api/v2/MT4/{tradePlatform}/DailyReportsRequestEx Get daily reports (grouped)
POST /api/v2/MT4/{tradePlatform}/DailySyncStart Start daily-report sync
POST /api/v2/MT4/{tradePlatform}/DailySyncRead Read daily-report sync

MT4 v2 :: Server Admin

GET /api/v2/MT4/{tradePlatform}/SrvFeeders List data feeders
GET /api/v2/MT4/{tradePlatform}/LicenseCheck/{licenseName} Check license
POST /api/v2/MT4/{tradePlatform}/NotificationsSend
GET /api/v2/MT4/{tradePlatform}/SrvFeederLog/{name} Get feeder log

MT4 v2 :: Server Admin (destructive)

POST /api/v2/MT4/{tradePlatform}/SrvRestart Restart server
POST /api/v2/MT4/{tradePlatform}/SrvChartsSync Force chart resync
POST /api/v2/MT4/{tradePlatform}/SrvLiveUpdateStart Start LiveUpdate distributor
POST /api/v2/MT4/{tradePlatform}/SrvFeedsRestart Restart data feeders

MT4 v2 :: Symbols

GET /api/v2/MT4/{tradePlatform}/SymbolInfoGet Get symbol market data (cached)
GET /api/v2/MT4/{tradePlatform}/SymbolInfoUpdated List updated symbols (cached)
GET /api/v2/MT4/{tradePlatform}/SymbolsGroupsGet List symbol groups (cached)
GET /api/v2/MT4/{tradePlatform}/CfgRequestSymbol List symbol configs
GET /api/v2/MT4/{tradePlatform}/CfgRequestSymbol/{symbol} Get symbol config
GET /api/v2/MT4/{tradePlatform}/SymbolSessionsGet/{symbol} Get symbol sessions
POST /api/v2/MT4/{tradePlatform}/CfgUpdateSymbol/{symbol} Update symbol config
PATCH /api/v2/MT4/{tradePlatform}/SymbolConfig/{symbol} Patch symbol config
POST /api/v2/MT4/{tradePlatform}/SymbolAdd/{symbol} Add symbol
POST /api/v2/MT4/{tradePlatform}/SymbolHide/{symbol} Hide symbol
POST /api/v2/MT4/{tradePlatform}/SymbolsRefresh Refresh symbol catalog
POST /api/v2/MT4/{tradePlatform}/SymbolChange Change symbol attributes
POST /api/v2/MT4/{tradePlatform}/SymbolSendTick Send synthetic tick

MT4 v2 :: Trades

GET /api/v2/MT4/{tradePlatform}/TradesGet List open trades (cached)
GET /api/v2/MT4/{tradePlatform}/TradesGet/{ticket} Get trade by ticket (cached)
GET /api/v2/MT4/{tradePlatform}/TradesGetByLogin/{login}/{group} List trades by account (cached)
GET /api/v2/MT4/{tradePlatform}/TradesGetBySymbol List trades by symbol (cached)
GET /api/v2/MT4/{tradePlatform}/TradesGetByMarket List market trades (cached)
GET /api/v2/MT4/{tradePlatform}/TradeRecordGet/{order} Get trade record (cached)
POST /api/v2/MT4/{tradePlatform}/TradeCheckStops Validate order stops
POST /api/v2/MT4/{tradePlatform}/TradeClearRollback/{order} Roll back trade transaction
GET /api/v2/MT4/{tradePlatform}/TradeRecordRequest/{order} Get trade record (live)
GET /api/v2/MT4/{tradePlatform}/TradesRequest Query trades (live)
POST /api/v2/MT4/{tradePlatform}/AdmTradeRecordModify/{ticket} Modify trade record (admin)
POST /api/v2/MT4/{tradePlatform}/TradeTransaction Submit trade transaction
GET /api/v2/MT4/{tradePlatform}/TradeRecordsRequest Get trade records batch (live)
GET /api/v2/MT4/{tradePlatform}/AdmTradesRequest/{group} List group trades (admin)
POST /api/v2/MT4/{tradePlatform}/AdmTradesDelete Delete trades (admin)
POST /api/v2/MT4/{tradePlatform}/TradesSyncStart Start trade-records sync

MT4 v2 :: Users

GET /api/v2/MT4/{tradePlatform}/UserRecordGet/{login} Get account (cached)
GET /api/v2/MT4/{tradePlatform}/UserRecordRequest/{login} Get account (live)
GET /api/v2/MT4/{tradePlatform}/UserRecordsRequest Get accounts batch (live)
GET /api/v2/MT4/{tradePlatform}/AdmBalanceCheck/{login} Check account balance
GET /api/v2/MT4/{tradePlatform}/AdmBalanceCheck Check account balances (batch)
POST /api/v2/MT4/{tradePlatform}/AdmBalanceFix Fix account balances
GET /api/v2/MT4/{tradePlatform}/UsersRequest List accounts (live)
POST /api/v2/MT4/{tradePlatform}/UserRecordNew Create account
POST /api/v2/MT4/{tradePlatform}/UserRecordUpdate/{login} Update account
PATCH /api/v2/MT4/{tradePlatform}/UserRecord/{login} Patch account
GET /api/v2/MT4/{tradePlatform}/AdmUsersRequestSafe/{group} List group accounts (admin)
POST /api/v2/MT4/{tradePlatform}/UsersSyncStart Start user-records sync
POST /api/v2/MT4/{tradePlatform}/UsersGroupOp Bulk account operation

MT5 v2 :: Common

GET /api/v2/MT5/{tradePlatform}/ServerTime Get server time
GET /api/v2/MT5/{tradePlatform}/TimeGet Get server time configuration

MT5 v2 :: Groups

GET /api/v2/MT5/{tradePlatform}/GroupGet/{group} Get a group by name
PATCH /api/v2/MT5/{tradePlatform}/GroupRecord/{group} Partially update a group

MT5 v2 :: Managers

GET /api/v2/MT5/{tradePlatform}/ManagerCurrent Get the current session manager

MT5 v2 :: Symbols

GET /api/v2/MT5/{tradePlatform}/SymbolGet/{symbol} Get a symbol by name
PATCH /api/v2/MT5/{tradePlatform}/SymbolRecord/{symbol} Partially update a symbol

MT5 v2 :: Trades

GET /api/v2/MT5/{tradePlatform}/PositionByGroup/{mask} List positions by group
GET /api/v2/MT5/{tradePlatform}/OrderByGroup/{mask} List orders by group
GET /api/v2/MT5/{tradePlatform}/DealByGroup/{mask} List deals by group

MT5 v2 :: Users

GET /api/v2/MT5/{tradePlatform}/UserGet/{login} Get a user by login
PATCH /api/v2/MT5/{tradePlatform}/UserRecord/{login} Partially update a user