Get equity chart

About

Returns equity chart by account id

GET /users/current/accounts/:accountId/equity-chart

For more information see Swagger documentation

Note: a backward incompatible update is planning for this endpoint, so in order to guarantee the backward compatibility of an application, the api-version header must be set to 1 (current default value). In the future update its default value will be changed to 2.

Headers

Name	Type	Required	Description
auth-token	string	Yes	authorization token. See Authentication & authorization
api-version	number		request version, default is 1 (will be changed in the future, see the note above)

Path parameters

Name	Type	Required	Description
accountId	string	Yes	id of the MetaApi account

Query parameters

Name	Type	Required	Description
startTime	string		starting broker time in in YYYY-MM-DD HH:mm:ss.SSS format
endTime	string		ending broker time in in YYYY-MM-DD HH:mm:ss.SSS format
realTime	boolean		if true, real-time data will be requested

Response

Responses:

• 200 - Equity chart returned successfully. Response schema: Array<EquityChartItem>
• 401 - Authorization failed. Response schema: Error
• 404 - MetaApi account not found. Response schema: Error

Examples

Example request:

curl -X GET --header 'Accept: application/json' --header 'auth-token: token' 'https://risk-management-api-v1.new-york.agiliumtrade.ai/users/current/accounts/105646d8-8c97-4d4d-9b74-413bd66cd4ed/equity-chart'

Example response:

[
  {
    "startBrokerTime": "2020-08-24 00:00:00.000",
    "endBrokerTime": "2020-08-25 00:00:00.000",
    "averageBalance": 10000,
    "minBalance": 8000,
    "maxBalance": 12000,
    "averageEquity": 10000,
    "minEquity": 8000,
    "maxEquity": 12000,
    "startBalance": 9000,
    "startEquity": 9000,
    "lastBalance": 10000,
    "lastEquity": 10000
  }
]