Docs
Lifecycle

Take an account offline

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

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.

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/cool"
{  "data": {    "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",    "stopped": true,    "state": "string"  }}

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.

List the instruments a signal can name GET

The markets fxapis names once, whatever each broker calls them: currency pairs, metals, indices, energies and crypto. A signal that names one of these as `instrument` is traded on every account under that account's own broker symbol. Needs no account and no broker.