Developer Portal
Admin APIsAccounts & FundingTrading

Open PositionsGET

Return the open positions for the specified trading account.

View as Markdown
GET
/accounts/{id}/positions

Authorization

Authorization<token>

Bearer access token issued by the admin login flow.

In: header

Path Parameters

idRequiredstring
curl -X GET "https://example.com/accounts/<string>/positions" \
  -H "Authorization: <token>"

A successful response.

{
  "positions": [
    {
      "id": "string",
      "symbolId": "string",
      "accountId": "string",
      "orderId": "string",
      "symbolName": "string",
      "openPrice": 0.1,
      "openPriceRaw": 0.1,
      "closePrice": 0.1,
      "closePriceRaw": 0.1,
      "side": "TRADE_SIDE_UNSPECIFIED",
      "status": "POSITION_STATUS_UNSPECIFIED",
      "commission": 0.1,
      "swap": 0.1,
      "profit": 0.1,
      "units": 0.1,
      "qty": 0.1,
      "qtyClosed": 0.1,
      "comment": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "realizedPnl": 0.1,
      "unitsClosed": 0.1,
      "usdPnl": 0.1,
      "currentPrice": 0.1,
      "margin": 0.1,
      "fundingAccrued": 0.1,
      "route": "POSITION_ROUTE_UNSPECIFIED",
      "gatewayId": "string"
    }
  ],
  "nextToken": "string"
}

Admin Login

Authenticate a back-office user (CRM/broker operator) and issue a bearer admin access token used to call this API. Tokens are valid for 30 days. Requests must originate from a whitelisted IP address.

Order History

Return one page of the account's orders in an inclusive UTC-second range, newest creation time first. There is no maximum range. Pass the returned nextToken back unchanged, with the same from/to, to fetch the next page; it is empty on the last page.