Get profit/drawdown tracker by id#
About#
Returns profit/drawdown tracker by id
GET /users/current/accounts/:accountId/trackers/:id
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 |
| id | string | Yes | id of the tracker |
Response#
Responses:
- 200 - Profit/drawdown tracker returned. Response schema: Tracker
- 401 - Authorization failed. Response schema: Error
- 404 - MetaApi account not found or the tracker does not belong to the MetaApi account. 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/trackers/ABCD'
Example response:
[
{
"_id": "ABCD",
"name": "Tracker 1",
"startBrokerTime": "2020-08-24 00:00:00.000",
"endBrokerTime": "2020-08-24 00:00:00.000",
"period": "day",
"relativeDrawdownThreshold": 0.1,
"absoluteDrawdownThreshold": 10000,
"relativeProfitThreshold": 0.05,
"absoluteProfitThreshold": 5000
}
]