CopyPro API Usage Manual

Overview

CopyPro provides a RESTful API used to manage accounts and copy trades between them via MetaTrader (MT4/MT5). This document describes each endpoint in detail for frontend and integration developers.

All endpoints are hosted under:

https://copy.mtapi.io/

Authentication

Most endpoints require a userKey, which can be obtained via the SignUp or SignIn endpoints.

User Management

Sign Up

GET /SignUp

Registers a new user.

Params:

• email: string
• passwordHash: string (client-side hashed)

Sign In

GET /SignIn

Authenticates user and returns userKey.

Params:

• email: string
• passwordHash: string (client-side hashed)

Accounts

Add Account

GET /AddAccount

Connects a MetaTrader account to the platform.

Params:

• name: Display name
• userKey: From SignIn
• type: MT4 or MT5
• user: Account number
• password: Account password
• server: Broker server name

Remove Account

GET /RemoveAccount

Removes a connected account.

Params:

• apiId: API token of the account
• userKey: Auth token

List Accounts

GET /Accounts

Returns all connected accounts and their connection status.

Params:

• userKey: string

Copying Trades

Start Copying

GET /Start

Connects master/slave accounts.

Required Params:

• userKey
• masterType, masterUser, masterPassword, masterServer, masterName
• slaveType, slaveUser, slavePassword, slaveServer, slaveName
• riskType, riskValue
• masterApiId, slaveApiId

Optional:

• copySL, copyTP
• fixedSlPips, fixedTpPips
• copyPendingOrders
• riskMultiply, fixedMasterBalance

Stop Copying

GET /Remove

Stops a copier by id.

Params:

• id: CopierId returned from Start

List Active Copiers

GET /UserCopiers

Lists all active copiers for a user.

Params:

• userKey: string

Copier Details

GET /GetCopier

Returns copier configuration by id.

Params:

• id: CopierId

Orders

Open Orders (Single Account)

GET /OpenOrders

Params:

• accountId: string

Open Orders (All Accounts)

GET /OpenOrdersAll

Params:

• userKey: string

Closed Orders (Single Account)

GET /ClosedOrders

Params:

• accountId: string
• from: DateTime
• to: DateTime

Closed Orders (All Accounts)

GET /ClosedOrdersAll

Params:

• userKey: string
• from: DateTime
• to: DateTime

Statistics

Trade Statistics by Account ID

GET /TradeStatsByAccountId

Params:

• accountId: string
• from: DateTime (optional)
• excludeSameBars: bool (default: true)

Trade Statistics by API ID

GET /TradeStatsByApiId

Params:

• apiId: string
• type: ApiType (MT4 or MT5)
• from: DateTime (optional)
• excludeSameBars: bool

Logs

Copier Logs

GET /Logs

Params:

• id: CopierId
• limit: number (default: 1000)
• logLevel: LogLevel

Trade Logs

GET /TradeLogs

Params:

• copierId: string
• limit: number (default: 100)

All Trade Logs for User

GET /TradeLogsAll

Params:

• userKey: string
• limit: number (default: 100)

Symbol Mapping

Get Mapped Symbols

GET /MappedSymbols

Params:

• copierId: string

Add Symbol Mapping

GET /AddSymbolMapping

Params:

• copierId: string
• masterSymbol: string
• slaveSymbol: string (use __ to include fixed lots, e.g., EURUSDmini__0.2)
• slavelots: decimal

Delete Symbol Mapping

GET /DeleteSymbolMapping

Params:

• copierId: string
• masterSymbol: string

Brokers

Get Server Names

GET /ServerNames

Params:

• mt5: bool (true = MT5, false = MT4)

Utilities

Headers Debug

GET /Headers

Returns incoming request headers.

Markdown ReadMe

GET /ReadMe

Returns readme.md as HTML.

Support

For questions or integration issues, contact support via the users.mtapi.io portal.

Trade Copier for MetaTrader 4 and MetaTrader 5

Full functional trial version for 14 days. More details and full version available at:

• Main website: https://mtapi.io
• Backend demo environment and documentation: https://copy.mtapi.io
• Postman docs
• Frontend demo environment: https://copy.mrpc.pro

YouTube Backend first steps to copy trades between MetaTrader 4 and MetaTrader 5

YouTube How to get acccount information from MT4 and MT5 using RESTful API

How to deploy with docker

1. Start client APIs

docker login reg.mtapi.io:5050
docker run -d --restart always -p 5014:80 --name lid4 reg.mtapi.io:5050/root/loginid-mt4-bin
docker run -p 5004:80 --add-host=host.docker.internal:host-gateway \
	-e LoginIdUrl='http://host.docker.internal:5014' -d --restart always \ 
	--name mt4 reg.mtapi.io:5050/root/mt4rest-full/mt4rest
docker run -d --restart always -p 5015:80 --name lid5 reg.mtapi.io:5050/root/loginid-mt5-bin
docker run -p 5005:80 --add-host=host.docker.internal:host-gateway \ 
	-e LoginIdUrl='http://host.docker.internal:5015' -d --restart always \ 
	--name mt5 reg.mtapi.io:5050/root/mt5rest-full/mt5rest

After that MT4 API available at port 5004, MT5 API at port 5005. 2. Start DB

docker run --name=mongo \
	-e=MONGO_INITDB_ROOT_USERNAME=main_admin \
	-e=MONGOINITDBROOTPASSWORD=some_password \ 
	--volume=/root/MongoData:/data/db \
	-p 27017:27017 --restart=always --runtime=runc --detach=true mongo

After that MongoDB available at port 27017. 3. Start copy backend

docker run -d --restart always -p 5020:80  --add-host=host.docker.internal:host-gateway --name copyback \ 
	-e ApiMT4='http://host.docker.internal:5004' \
	-e ApiMT5='http://host.docker.internal:5005' \
	-e MongoDB='mongodb://main_admin:some_password@host.docker.internal:27017' \
	reg.mtapi.io:5050/root/tradecopy

After that copier backend available at port 5020. 4. Start copy frontend

docker run -d --restart always -p 5030:8080  --add-host=host.docker.internal:host-gateway --name copyfront \ 
	-e CopyBackend='http://host.docker.internal:5020' \
	reg.mtapi.io:5050/root/copyfront

After that copier frontend at port 5030.

Building from sources

git clone https://git.mtapi.io/root/tradecopy
cd tradecopy
docker build -t tradecopy ./tradecopy
docker run -d --restart always --name tc -p 5009:80 tradecopy
After that service available at port 5009.