Skip to content

Create profit/drawdown tracker#

About#

Creates a profit/drawdown tracker

POST /users/current/accounts/:accountId/trackers

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

Body#

Create tracker schema: NewTracker

Response#

Responses:

  • 201 - Profit/drawdown tracker created and tracker id returned. Response schema: {id: string}
  • 401 - Authorization failed. Response schema: Error
  • 404 - MetaApi account not found. Response schema: Error

Examples#

Example request:

curl -X POST --header 'Accept: application/json' --header 'auth-token: token' -d '{
  "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
}' 'https://risk-management-api-v1.new-york.agiliumtrade.ai/users/current/accounts/105646d8-8c97-4d4d-9b74-413bd66cd4ed/trackers'