Docs
Accounts

Poll lifecycle state

GET
/v1/accounts/{id}/status

The endpoint to poll after bringing an account online. Cheap enough to call every second or two; state reaches ready when the account is logged in and ready to 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 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

id*string
Formatuuid

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/accounts/497f6eca-6276-4993-bfeb-53cbbbba6f08/status"
{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "state": "created",    "detail": null,    "since": "2019-08-24T14:15:22Z",    "mode": "always_on",    "tradingDisabled": true  }}