Restart the connection
Request
Synthetic example for the production API. Replace YOUR_API_KEY and the ids. Do not send it against a live account until you mean to.
curl -X POST "https://api.fxapis.com/v1/accounts/ACCOUNT_ID/restart" \
-H "Authorization: Bearer YOUR_API_KEY"For an account that is online but misbehaving — degraded, stale quotes, a stuck sync. Returns 202; poll pollUrl until state is ready. Refused with 409 while an order is in flight, for the same reason as taking it offline. Returns 402 QUOTA_EXCEEDED when the workspace has no plan.
Returns 429 RESTART_TOO_SOON (with retry-after) when the account's terminal has already been started 3 times in the last 10 minutes; the account is left as it is.
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
application/json
application/json
curl -X POST "https://api.fxapis.com/v1/accounts/497f6eca-6276-4993-bfeb-53cbbbba6f08/restart"{ "data": { "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9", "runtimeId": "f8fedceb-4f2e-4026-b3e7-d1baf36cf8bc", "alreadyRunning": true, "state": "created", "pollUrl": "string" }}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.
Take an account offline POST
Takes the account offline and keeps it, with its stored password, in `standby` — ready to be brought online again. Open positions are untouched: a stop loss or take profit is held by the broker and keeps working while the account is offline. Returns 409 while an order is in flight. Going offline then would turn a known outcome into an unknown one, and a retry on top of that is a duplicate trade.