Get tracker events#
About#
Returns tracker events by broker time range
GET /users/current/tracker-events/by-broker-time
For more information see Swagger documentation
Headers#
Name | Type | Required | Description |
---|---|---|---|
auth-token | string | Yes | authorization token. See Authentication & authorization |
Query parameters#
Name | Type | Required | Description |
---|---|---|---|
startBrokerTime | string | value of the event time in broker timezone to start loading data from, inclusive, in YYYY-MM-DD HH:mm:ss.SSS format | |
endBrokerTime | string | value of the event time in broker timezone to end loading data at, inclusive, in YYYY-MM-DD HH:mm:ss.SSS format | |
accountId | string | id of the MetaApi account | |
trackerId | string | id of the drawdown tracker | |
limit | integer | pagination limit, default: 1000 , min: 1 , max: 1000 |
Response#
Responses:
- 200 - Tracker events returned successfully. Response schema: Array<TrackerEvent>
- 401 - Authorization failed. 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/tracker-events/by-broker-time'
Example response:
[
{
"sequenceNumber": 1,
"accountId": "105646d8-8c97-4d4d-9b74-413bd66cd4ed",
"trackerId": "ABCD",
"startBrokerTime": "2020-08-24 00:00:00.000",
"endBrokerTime": "2020-08-24 00:00:00.000",
"period": "day",
"brokerTime": "2020-08-24 00:00:00.000",
"absoluteDrawdown": 10000,
"relativeDrawdown": 0.1,
"absoluteProfit": 5000,
"relativeProfit": 0.05,
"exceededThresholdType": "drawdown"
}
]