Bring several accounts online at once
Brings every account listed online and returns 202 with a result for each — the broker logins are still in progress. Built for a signal: call it when the signal goes out, and by the time people act on it their accounts are online, so the order goes straight through instead of waiting for a login.
An account already online is reported as already_running; one that needs a human first (needs_operator) is not retried. warm_on_demand accounts go offline again by themselves after the idle window with no orders.
Authorization
apiKey Authorization: Bearer fx_live_<id>_<secret>.
A key is shown once, at creation. We cannot show it again or recover it for you.
Keys carry an environment (live or test) in the key itself, so a test key pasted into a
production config fails immediately instead of at the worst possible moment.
Scopes are per key. A key without accounts:write can read accounts and nothing else.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/v1/accounts/prepare" \ -H "Content-Type: application/json" \ -d '{ "accountIds": [ "b75e4440-1cc9-49a6-8c9e-087e1aa69722" ] }'{ "data": [ { "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9", "result": "starting", "message": null } ]}Bring an account online POST
Starts connecting the account and returns **202** immediately — the broker login is still in progress. Poll `pollUrl` until `state` is `ready`. Calling this for an account that is already online is harmless and returns `alreadyRunning: true`, so a client that is unsure can simply call it. Returns 409 when the account needs a human first (a wrong password, 2FA, a certificate, trading disabled at the broker). Retrying will not fix those, and repeated failed logins are how a broker locks an account.
Change how eagerly the account stays connected POST
`always_on`: stays connected. `warm_on_demand`: connects on demand (the first order, or a prepare) and goes offline by itself when idle. `cold`: connects only when you ask. Takes effect the next time the account is brought online, so the call stays fast and predictable. Switch to `always_on` and then bring the account online to apply it now.