Bring an account online
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.
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 a label (live or test) in the key itself, so each configuration is easy to tell
apart. Both reach real brokers: test with a broker demo account.
Scopes are per key. A key without accounts:write can read accounts and nothing else.
In: header
Path Parameters
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/accounts/497f6eca-6276-4993-bfeb-53cbbbba6f08/warm"{ "data": { "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9", "runtimeId": "f8fedceb-4f2e-4026-b3e7-d1baf36cf8bc", "alreadyRunning": true, "state": "created", "pollUrl": "string" }}What happened to an account GET
The account's history in words, newest first: added, logging in, refused by the broker, online, moved to another server, taken offline. The same record the console shows as the account's activity.
Bring several accounts online at once POST
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.