Docs
Lifecycle

Disconnect and erase the credential

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/disconnect" \
  -H "Authorization: Bearer YOUR_API_KEY"
POST
/v1/accounts/{id}/disconnect

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.

Authorization

apiKey
AuthorizationBearer <token>

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

id*string
Formatuuid

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://api.fxapis.com/v1/accounts/497f6eca-6276-4993-bfeb-53cbbbba6f08/disconnect"
{  "data": {    "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",    "state": "string",    "credentialsRemoved": true  }}

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. A copy-trading strategy's account must stay `always_on`: moving it to another mode is refused with 409 `ACCOUNT_IS_MASTER` until the strategy is archived.

Restart the connection POST

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.