Change how eagerly the account stays connected
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.
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
Path Parameters
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/accounts/497f6eca-6276-4993-bfeb-53cbbbba6f08/mode" \ -H "Content-Type: application/json" \ -d '{ "mode": "always_on" }'{ "data": { "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9", "mode": "always_on", "restingState": "string" }}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.
Disconnect and erase the credential POST
Takes the account offline and **deletes the stored password**. The account record stays, with its history, in `offline`. Reconnecting means sending the password again. This is the endpoint to call when a customer leaves. A disconnected account that still holds a usable password is a credential nobody is watching.