Read deals by position

About

Returns history deals for a specific position id

For more information see Async api documentation

Request

In order to retrieve history deals by position, your application needs to emit request event with the following payload.

Name	Type	Required	Description
type	string	Yes	request type, must be getDealsByPosition if you want to retrieve deals by position
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
requestId	string	Yes	request id which your application must supply. Request id must be unique during an API connection
application	string	Yes	MetaApi application id. Default is RPC
application	string		MetaApi application id. Default is RPC

Response

After executing your request the API server will emit response event with the following payload.

Name	Type	Required	Description
type	string	Yes	The value of this field will be response in the response to the above request
requestId	string	Yes	request id the response relates to
accountId	string	Yes	account id specified in the request
deals	array	Yes	History deals with requested position id for a specified MetaTrader account. Response schema: Array<MetatraderDeal>
synchronizing	boolean	Yes	If this field is true, this means that the data synchronization with the terminal is not yet complete and the data may not be accurate

Code example

import ioClient from 'socket.io-client';

const socket = ioClient('https://mt-client-api-v1.new-york.agiliumtrade.ai', {
    path: '/ws',
    reconnection: false,
    query: {
        'auth-token': 'token'
    }
});

const request = {
    accountId: '23ccdd23-0b8a-400d-9aba-0129de365ba9',
    type: 'getDealsByPosition',
    requestId: 'b1680fce-c505-4be2-b895-d84e3f1618cb',
    positionId: '46214692'
};

socket.on('connect', () => {
    socket.emit('request', request);
});

socket.on('response', response => {
  console.log(response);
});

socket.on('processingError', err => {
  console.error(err);
});

Response example

{
  "type": "response",
  "requestId": "b1680fce-c505-4be2-b895-d84e3f1618cb",
  "deals": [
    {
      "clientId": "TE_GBPUSD_7hyINWqAlE",
      "commission": -0.25,
      "entryType": "DEAL_ENTRY_IN",
      "id": "33230099",
      "magic": 1000,
      "platform": "mt5",
      "orderId": "46214692",
      "positionId": "46214692",
      "price": 1.26101,
      "profit": 0,
      "swap": 0,
      "symbol": "GBPUSD",
      "time": "2020-04-15T02:45:06.521Z",
      "brokerTime": "2020-04-15 05:45:06.521",
      "type": "DEAL_TYPE_BUY",
      "volume": 0.07
    }
  ],
  "synchronizing": false,
  "accountId": "23ccdd23-0b8a-400d-9aba-0129de365ba9"
}