Docs
History

An account's full deal history

GET
/v1/accounts/{id}/deals

Everything the broker recorded against this account, including deals no order of yours caused — a stop loss firing, a swap charge, a deposit, or somebody trading the same login from the MetaTrader desktop.

That inclusion is the point. A history containing only your own orders would show an account whose balance moves for no visible reason. Ordered by the broker's timestamp, not ours.

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

Query Parameters

accountId?string

Narrow to one account.

Formatuuid
state?string

unknown is the set whose result we are still confirming with the broker.

Value in

  • "accepted"
  • "validating"
  • "sending"
  • "working"
  • "completed"
  • "filled"
  • "partially_filled"
  • "rejected"
  • "failed"
  • "unknown"
  • "cancelled"
  • "expired"
symbol?string
Lengthlength <= 32
since?string
Formatdate-time
until?string
Formatdate-time
limit?integer
Range1 <= value <= 200
Default50
cursor?string

The nextCursor from the previous page.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/accounts/497f6eca-6276-4993-bfeb-53cbbbba6f08/deals"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",      "orderId": null,      "brokerDealId": "string",      "brokerOrderId": null,      "brokerPositionId": null,      "symbol": "string",      "dealType": "string",      "entry": null,      "volume": null,      "price": null,      "commission": null,      "swap": null,      "profit": null,      "fee": null,      "dealtAt": "2019-08-24T14:15:22Z",      "comment": null    }  ],  "page": {    "hasMore": true,    "nextCursor": null  }}

Positions on an account GET

What we last saw, with `observedAt` saying when. The broker is authoritative and this is a snapshot, not a ledger — `observedAt` is here so you can tell a current view from a stale one rather than having to assume. Open positions only, unless `includeClosed=true`.

Deals produced by one order GET

One order can produce several deals — a partial fill leaves more than one. These are the broker's own records of money changing hands, which is what a statement is reconciled against.