Skip to content

Read positions#


Returns positions for a specified MetaTrader account

GET /users/current/accounts/:accountId/positions

For more information see Swagger documentation. Note, that this URL is valid for new-york region only. You can find URLs for other regions on API access page.


Name Type Required Description
auth-token string Yes authorization token. See Authentication & authorization

Path parameters#

Name Type Required Description
accountId string Yes MetaTrader account id. You can retrieve account id from Web application after you add your MetaTrader account to our platform. The account id can also be obtained via Provisioning API

Query parameters#

Name Type Required Description
refreshTerminalState boolean whether to refresh terminal state before retrieving the data, slowing down the request. Defaults to false


  • 200 - Positions for a specified MetaTrader account returned successfully. Response schema: Array<MetatraderPosition>
  • 401 - Authorization failed. Response schema: Error
  • 404 - MetaTrader account not found or not provisioned yet. Response schema: Error


Example request:

curl -X GET --header 'Accept: application/json' --header 'auth-token: token' ''

Example response:

    "id": "46648037",
    "type": "POSITION_TYPE_BUY",
    "symbol": "AUDNZD",
    "magic": 1000,
    "time": "2020-04-17T04:30:03.223Z",
    "brokerTime": "2020-04-17 07:30:03.223",
    "openPrice": 1.05782,
    "currentPrice": 1.05307,
    "currentTickValue": 0.5994,
    "stopLoss": 0.99876,
    "volume": 0.1,
    "swap": -0.5,
    "profit": -28.472110000000026,
    "updateTime": "2020-04-20T08:54:42.119Z",
    "commission": -0.5,
    "clientId": "AS_AUDNZD_46648037",
    "unrealizedProfit": -28.471500000000194,
    "realizedProfit": -0.0006099999998312455