MEmetacopier
Account API

Create an account

Changed on

Creates a new account. If a callbackUrl is provided in the request body, the account creation is processed asynchronously: the API returns 202 Accepted immediately with a requestId, and POSTs the result to the callback URL once done. Only one account creation per project is processed at a time; additional async requests are queued and processed sequentially.

post/rest/api/v1/accounts

Request

Request body

aliasstring
callbackUrlstring

Optional callback URL for async processing, supported on create (POST) and update (PUT). When provided, the API returns 202 Accepted immediately and POSTs the result (AccountDTO or error) to this URL once processing completes. Only 1 request 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

Only used on create (POST). 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.

validateCredentialsOnChangeboolean

Only used on update (PUT). When set to true and a new loginAccountPassword is supplied, the new credentials are verified against the broker before they are stored. The request fails with [WRONG_CREDENTIALS] if they are invalid, so no polling of accountInformation is needed. Adds several seconds to the request.

Example request

{
  "accountInformation": {
    "expertAdvisorResources": [
      {
        "cpuPercent": 3.4,
        "memoryBytes": 734003200
      }
    ]
  },
  "callbackUrl": "https://example.com/webhook/account-created"
}

Response

The created account

aliasstring
callbackUrlstring

Optional callback URL for async processing, supported on create (POST) and update (PUT). When provided, the API returns 202 Accepted immediately and POSTs the result (AccountDTO or error) to this URL once processing completes. Only 1 request 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

Only used on create (POST). 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.

validateCredentialsOnChangeboolean

Only used on update (PUT). When set to true and a new loginAccountPassword is supplied, the new credentials are verified against the broker before they are stored. The request fails with [WRONG_CREDENTIALS] if they are invalid, so no polling of accountInformation is needed. Adds several seconds to the request.

Example response

{
  "accountInformation": {
    "expertAdvisorResources": [
      {
        "cpuPercent": 3.4,
        "memoryBytes": 734003200
      }
    ]
  },
  "callbackUrl": "https://example.com/webhook/account-created"
}

Changes

  • 2ac6d7461345Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property to the response with the status

  • ada0d2c152ccRevision changes
    • info

      added the optional property //// to the response with the status

    • info

      added the optional property /// to the response with the status