Sign in
latestOpenAPI 3.0.12026-08-16171142480.4 KB

ff1699330afa

Account API

Get all accounts

get/rest/api/v1/accounts

Query parameters

accountTypeIdinteger

Filter by account type ID (1=MT5, 2=MT4, 3=DXtrade, 4=cTrader, 5=TradeLocker, 6=MatchTrader, 7=Binance, 8=Bybit, 9=Bitget, 10=BloFin, 11=OKX, 12=TradeStation, 13=Tradovate, 14=Alpaca, 15=Gate.io, 16=Bitunix, 17=Hyperliquid)

loginServerstring

Filter by login server (case-insensitive partial match anywhere in the server name, e.g., ICMarketsSC-MT5-4, dxtrade.instantfunding.io, live.ctraderapi.com:5035)

loginAccountNumberstring

Filter by login account number (case-insensitive partial match anywhere in the account number)

aliasstring

Filter by account alias (case-insensitive partial match anywhere in the alias)

regionIdinteger

Filter by region ID (1=New York, 2=London, 3=Singapore, 4=Berlin)

accountStatusIdinteger

Filter by account status ID (1=New, 2=Active, 3=Stopped, 4=Deleted)

limitinteger

Maximum number of accounts to return

offsetinteger

Number of accounts to skip for pagination

Response

OK

aliasstring
callbackUrlstring

Optional callback URL for async account creation. When provided, the API returns 202 Accepted immediately and POSTs the result (AccountDTO or error) to this URL once processing completes. Only 1 account creation per project is processed at a time; additional requests are queued.

closeUnmanagedPositionsboolean

When enabled, any open positions on the account that were originally opened by MetaCopier but are no longer managed, due to technical issues, will be automatically closed. However, this mechanism can occasionally result in false positives. If disabled, such unmanaged positions will remain open, and a notification will be sent to the notification center or to Telegram (if configured). In this case, manual intervention is required. We recommend keeping this option disabled to avoid accidental closures.

createdstring date-time

ISO 8601

ctraderClientIdstring
ctraderClientSecretstring
deletedstring date-time

ISO 8601

failIfAccountExistsInProjectboolean

If true, the create-account call fails when the account already exists in the project

hasActiveCopiersboolean

Indicates whether this account has any active copiers. Returns true if at least one copier has active=true, false otherwise.

hasDisabledCopiersboolean

Indicates whether this account has any disabled only copiers. Returns true if at least one copier has active=false, false otherwise.

hasMonitorOnlyCopiersboolean

Indicates whether this account has any monitor-only copiers. Returns true if at least one copier is in monitor only mode (monitoring without copying trades), false otherwise.

idstring uuid
labelsstring[]

Set labels for your account. If null, this field will not add, update, or delete anything. To delete all labels, set this field to an empty list.

loginAccountNumberstring

For Binance, Bybit, Bitget, BloFin, OKX, Tradovate and Alpaca leave it empty

loginAccountPasswordstring required

For cTrader 'token|refreshToken'. For TradeStation 'token|refreshToken'. For Binance and Bybit 'apiKey|secretKey'. For Bitget, BloFin and OKX 'apiKey|secretKey|passphrase'. For Tradovate and Alpaca 'apiKey|secretKey'. Only fill this field if you want to update the password or at account creation. When updating the account, you can leave this field empty "" - you don't have to send the password every time.

loginServerstring required

Enter the server address, for example, ICMarketsSC-MT5-4 for MetaTrader, or the URL such as dxtrade.instantfunding.io for DXtrade or mtr-demo-prod.match-trader.com MatchTrader. For CTrader, live.ctraderapi.com:5035 or demo.ctraderapi.com:5035. For TradeLocker, live.tradelocker.com or demo.tradelocker.com. For Binance, Bybit, Bitget, BloFin and OKX 'live', 'testnet' or 'demo'. For TradeStation 'sim' or 'live'. For Tradovate 'demo' or 'live'. For Alpaca 'paper' or 'live'.

nativeModeboolean

Indicates whether the integration runs in native mode (applies only to MetaTrader 4/5 connectors). If true, the solution operates via the official MetaTrader terminal (native). If false, it connects directly to the server without using the terminal (non-native). Non-native mode can achieve lower latency for high-frequency trading (HFT) strategies, but for 99% of typical use cases native mode is sufficiently fast. If the non-native mode fails or becomes unavailable, the system will automatically fall back to native mode. For all other connectors, the integration is always native.

propFirmboolean

Indicates whether this is a prop firm account.

skipCredentialCheckboolean

When set to true, skips credential validation during account creation. Use with caution, the account will be created without verifying login credentials.

statusMessagestring
tradingDisabledboolean

When enabled, puts the account in read-only mode, preventing any new trades from being opened or existing trades from being modified or closed. Use this when you want to use the account as a read-only master.

Example response

[
  {
    "callbackUrl": "https://example.com/webhook/account-created"
  }
]