View as Markdown

API reference / Models

Models

AccountFeatures

AccountFeatures fields
FieldTypeDescription
copyFactoryApiCopyTradingEnable | null
riskManagementApiEnabledboolean | null
metastatsApiEnabledboolean | null
reliabilityIncreasedboolean | null
allocateDedicatedIp"ipv4" | "none" | null

CopyTradingEnable

CopyTradingEnable fields
FieldTypeDescription
copyFactoryRoles required"PROVIDER" | "SUBSCRIBER"[]
copyFactoryResourceSlotsinteger | null

CreateAccount

CreateAccount fields
FieldTypeDescription
platform"mt4" | "mt5"
server requiredstring
login requiredinteger
password requiredstring
nicknamestring
trade_ea_symbolstring
proxy_addressstring
proxy_typestring
proxy_authstring
proxy_local_portinteger

CreatePrivateServer

CreatePrivateServer fields
FieldTypeDescription
slots requiredinteger
region requiredstring
name requiredstring

CreateReadonlyKey

CreateReadonlyKey fields
FieldTypeDescription
name requiredstring
scope"all" | "selected"
account_idsstring[]

CreateTopup

CreateTopup fields
FieldTypeDescription
amount_eur_cents requiredinteger
method"crypto" | "manual"

CreateWebhook

CreateWebhook fields
FieldTypeDescription
url requiredstring
secretstring | null

Credentials

Credentials fields
FieldTypeDescription
loginstring | integer | null
password requiredstring

HTTPValidationError

HTTPValidationError fields
FieldTypeDescription
detailValidationError[]

KeyBody

KeyBody fields
FieldTypeDescription
namestring

MoveAccounts

MoveAccounts fields
FieldTypeDescription
account_ids requiredstring[]

NewProfile

NewProfile fields
FieldTypeDescription
name requiredstring
version required4 | 5
brokerTimezone requiredstring
brokerDSTSwitchTimezone requiredstring
type"mtTerminal" | "managerApi"
managerLoginstring | null
managerPasswordstring | null
managerServerstring | null

NewToken

NewToken fields
FieldTypeDescription
namestring
kind"api" | "account"
applicationsstring[] | null
rolesstring[] | null
accountIdsstring[] | null
readOnlyboolean
ttlInHoursnumber | null
ipAllowliststring[] | null

NewTradingAccount

NewTradingAccount fields
FieldTypeDescription
name requiredstring
server requiredstring
loginstring | integer | null
passwordstring | null
platform"mt4" | "mt5" | null
provisioningProfileIdstring | null
magicinteger
manualTradesboolean
slippagenumber | null
quoteStreamingIntervalInSecondsnumber
tagsstring[]
metadataobject | null
reliability"regular" | "high"
resourceSlotsinteger
copyFactoryResourceSlotsinteger
regionstring | null
type"cloud" | "cloud-g1" | "cloud-g2"
symbolstring | null
baseCurrencystring | null
copyFactoryRoles"PROVIDER" | "SUBSCRIBER"[]
riskManagementApiEnabledboolean
metastatsApiEnabledboolean
allocateDedicatedIp"ipv4" | "none" | null
keywordsstring[]
serverAddressstring | null

PatchAccount

PatchAccount fields
FieldTypeDescription
trade_ea_symbolstring | null

PatchEndpoint

PatchEndpoint fields
FieldTypeDescription
enabledEventsstring[] | null
urlstring | null
descriptionstring | null

PatchPrivateServer

PatchPrivateServer fields
FieldTypeDescription
slots requiredinteger

PatchReadonlyKey

PatchReadonlyKey fields
FieldTypeDescription
namestring | null
scope"all" | "selected" | null
account_idsstring[] | null

PatchToken

PatchToken fields
FieldTypeDescription
namestring | null
ipAllowliststring[] | null

PinBody

PinBody fields
FieldTypeDescription
apiVersion requiredstring

PrivateServerAddAccount

PrivateServerAddAccount fields
FieldTypeDescription
platform"mt4" | "mt5"
server requiredstring
login requiredinteger
password requiredstring
nicknamestring
trade_ea_symbolstring

RotateSecret

RotateSecret fields
FieldTypeDescription
secretstring | null
overlapHoursnumber

SandboxSignupBody

SandboxSignupBody fields
FieldTypeDescription
platform"mt4" | "mt5"

TriggerBody

TriggerBody fields
FieldTypeDescription
type requiredstring
accountIdstring | null

UpdateProfile

UpdateProfile fields
FieldTypeDescription
namestring | null
brokerTimezonestring | null
brokerDSTSwitchTimezonestring | null
managerLoginstring | null
managerPasswordstring | null
managerServerstring | null

UpdateTradingAccount

UpdateTradingAccount fields
FieldTypeDescription
namestring | null
passwordstring | null
serverstring | null
magicinteger | null
manualTradesboolean | null
slippagenumber | null
quoteStreamingIntervalInSecondsnumber | null
tagsstring[] | null
metadataobject | null
copyFactoryRoles"PROVIDER" | "SUBSCRIBER"[] | null
resourceSlotsinteger | null
copyFactoryResourceSlotsinteger | null
metastatsApiEnabledboolean | null
allocateDedicatedIp"ipv4" | "none" | null
serverAddressstring | null

UpgradeBody

UpgradeBody fields
FieldTypeDescription
accounts requiredinteger
own_addressboolean

ValidationError

ValidationError fields
FieldTypeDescription
loc requiredstring | integer[]
msg requiredstring
type requiredstring
inputany
ctxobject