Skip to main content
POST
Create account

Authorizations

X-API-Key
string
header
required

Client API key (prefixed with sk_). On /api/* endpoints the key is scoped to its own MT5 accounts. On /admin/* endpoints the key identifies its owning admin and grants access to all of that admin's keys — so any of your sk_ works to manage any of your other keys (cross-admin operations are rejected as 400 Key not found).

Body

application/json
label
string
required

Friendly name

Example:

"ICMarkets Demo"

mt5_login
integer<int64>
required

MT5 account number

Example:

51234567

password
string
required

MT5 account password (stored encrypted with AES-256-GCM)

Example:

"MyP@ssw0rd"

broker_host
string

MT5 broker server hostname or IP

Example:

"mt5-demo.icmarkets.com"

broker_port
integer
default:443

Broker port

Example:

443

server_name
string

MT5 server name (alternative to host/port)

Example:

"ICMarketsSC-Demo"

auto_connect
boolean
default:false

Auto-connect on gateway start

hardware_id
string

Optional hardware ID for the MT5 terminal

proxy_host
string

SOCKS5 proxy hostname

proxy_port
integer

SOCKS5 proxy port

proxy_user
string

Proxy username

proxy_password
string

Proxy password

Response

Account created

ok
boolean
Example:

true

data
object