Place one trade on many accounts
place_multi_account_orderPlaces the same market order on many of the user's real broker accounts (or demo) at once and returns at once; follow it with get_multi_account_order. Confirm the accounts, symbol, side and volume with the user first. Example: {"account_ids": ["", ""], "instrument": "XAUUSD", "side": "buy", "volume": "0.01", "idempotency_key": ""}
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| side | Yes | buy or sell. | |
| label | No | A name for this multi-account order. | |
| symbol | No | The symbol exactly as this broker names it, e.g. "EURUSD" — some brokers add a suffix such as "EURUSD.r". | |
| volume | Yes | Size per account, unless weights overrides it for an account. In lots, preferably as a string: "0.01" is a micro lot, "1.00" a standard lot. | |
| comment | No | Optional note stored on the order. MT5 keeps the first 17 characters after our reference. | |
| weights | No | Optional per-account size, keyed by account id, e.g. {"<account id>": "0.05"}. | |
| stop_loss | No | Optional stop loss for every account. An absolute price (e.g. "1.08450"), not a distance in pips or points. | |
| execute_at | No | When to send. Omit to send as soon as every account is online. | |
| expires_at | No | Stop waiting for accounts after this. | |
| instrument | No | Instead of symbol: an instrument from list_instruments, e.g. XAUUSD. Each account trades its own broker's symbol for it; the whole order is refused if any account's broker does not offer it. | |
| account_ids | Yes | The accounts to trade on, one order each. | |
| take_profit | No | Optional take profit for every account. An absolute price (e.g. "1.08450"), not a distance in pips or points. | |
| barrier_policy | No | When some accounts are not online in time: release-ready (default) trades on those that are; all-or-nothing trades on none unless all are; wait keeps waiting until expires_at. | |
| idempotency_key | Yes | A unique string you generate for THIS action, e.g. a fresh UUID. If a call fails or times out and you retry the same action, send the SAME key: fxapis then returns the first result instead of acting twice. Use a new key only for a genuinely new action. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| multi_account_order | Yes |