API reference / Models
Models
AccountFeatures
| Field | Type | Description |
|---|---|---|
copyFactoryApi | CopyTradingEnable | null | |
riskManagementApiEnabled | boolean | null | |
metastatsApiEnabled | boolean | null | |
reliabilityIncreased | boolean | null | |
allocateDedicatedIp | "ipv4" | "none" | null |
CopyTradingEnable
| Field | Type | Description |
|---|---|---|
copyFactoryRoles required | "PROVIDER" | "SUBSCRIBER"[] | |
copyFactoryResourceSlots | integer | null |
CreateAccount
| Field | Type | Description |
|---|---|---|
platform | "mt4" | "mt5" | |
server required | string | |
login required | integer | |
password required | string | |
nickname | string | |
trade_ea_symbol | string | |
proxy_address | string | |
proxy_type | string | |
proxy_auth | string | |
proxy_local_port | integer |
CreatePrivateServer
| Field | Type | Description |
|---|---|---|
slots required | integer | |
region required | string | |
name required | string |
CreateReadonlyKey
| Field | Type | Description |
|---|---|---|
name required | string | |
scope | "all" | "selected" | |
account_ids | string[] |
CreateTopup
| Field | Type | Description |
|---|---|---|
amount_eur_cents required | integer | |
method | "crypto" | "manual" |
CreateWebhook
| Field | Type | Description |
|---|---|---|
url required | string | |
secret | string | null |
Credentials
| Field | Type | Description |
|---|---|---|
login | string | integer | null | |
password required | string |
HTTPValidationError
| Field | Type | Description |
|---|---|---|
detail | ValidationError[] |
KeyBody
| Field | Type | Description |
|---|---|---|
name | string |
MoveAccounts
| Field | Type | Description |
|---|---|---|
account_ids required | string[] |
NewProfile
| Field | Type | Description |
|---|---|---|
name required | string | |
version required | 4 | 5 | |
brokerTimezone required | string | |
brokerDSTSwitchTimezone required | string | |
type | "mtTerminal" | "managerApi" | |
managerLogin | string | null | |
managerPassword | string | null | |
managerServer | string | null |
NewToken
| Field | Type | Description |
|---|---|---|
name | string | |
kind | "api" | "account" | |
applications | string[] | null | |
roles | string[] | null | |
accountIds | string[] | null | |
readOnly | boolean | |
ttlInHours | number | null | |
ipAllowlist | string[] | null |
NewTradingAccount
| Field | Type | Description |
|---|---|---|
name required | string | |
server required | string | |
login | string | integer | null | |
password | string | null | |
platform | "mt4" | "mt5" | null | |
provisioningProfileId | string | null | |
magic | integer | |
manualTrades | boolean | |
slippage | number | null | |
quoteStreamingIntervalInSeconds | number | |
tags | string[] | |
metadata | object | null | |
reliability | "regular" | "high" | |
resourceSlots | integer | |
copyFactoryResourceSlots | integer | |
region | string | null | |
type | "cloud" | "cloud-g1" | "cloud-g2" | |
symbol | string | null | |
baseCurrency | string | null | |
copyFactoryRoles | "PROVIDER" | "SUBSCRIBER"[] | |
riskManagementApiEnabled | boolean | |
metastatsApiEnabled | boolean | |
allocateDedicatedIp | "ipv4" | "none" | null | |
keywords | string[] | |
serverAddress | string | null |
PatchAccount
| Field | Type | Description |
|---|---|---|
trade_ea_symbol | string | null |
PatchEndpoint
| Field | Type | Description |
|---|---|---|
enabledEvents | string[] | null | |
url | string | null | |
description | string | null |
PatchPrivateServer
| Field | Type | Description |
|---|---|---|
slots required | integer |
PatchReadonlyKey
| Field | Type | Description |
|---|---|---|
name | string | null | |
scope | "all" | "selected" | null | |
account_ids | string[] | null |
PatchToken
| Field | Type | Description |
|---|---|---|
name | string | null | |
ipAllowlist | string[] | null |
PinBody
| Field | Type | Description |
|---|---|---|
apiVersion required | string |
PrivateServerAddAccount
| Field | Type | Description |
|---|---|---|
platform | "mt4" | "mt5" | |
server required | string | |
login required | integer | |
password required | string | |
nickname | string | |
trade_ea_symbol | string |
RotateSecret
| Field | Type | Description |
|---|---|---|
secret | string | null | |
overlapHours | number |
SandboxSignupBody
| Field | Type | Description |
|---|---|---|
platform | "mt4" | "mt5" |
TriggerBody
| Field | Type | Description |
|---|---|---|
type required | string | |
accountId | string | null |
UpdateProfile
| Field | Type | Description |
|---|---|---|
name | string | null | |
brokerTimezone | string | null | |
brokerDSTSwitchTimezone | string | null | |
managerLogin | string | null | |
managerPassword | string | null | |
managerServer | string | null |
UpdateTradingAccount
| Field | Type | Description |
|---|---|---|
name | string | null | |
password | string | null | |
server | string | null | |
magic | integer | null | |
manualTrades | boolean | null | |
slippage | number | null | |
quoteStreamingIntervalInSeconds | number | null | |
tags | string[] | null | |
metadata | object | null | |
copyFactoryRoles | "PROVIDER" | "SUBSCRIBER"[] | null | |
resourceSlots | integer | null | |
copyFactoryResourceSlots | integer | null | |
metastatsApiEnabled | boolean | null | |
allocateDedicatedIp | "ipv4" | "none" | null | |
serverAddress | string | null |
UpgradeBody
| Field | Type | Description |
|---|---|---|
accounts required | integer | |
own_address | boolean |
ValidationError
| Field | Type | Description |
|---|---|---|
loc required | string | integer[] | |
msg required | string | |
type required | string | |
input | any | |
ctx | object |