Skip to content

Get strategy by id#

About#

Returns provider strategy the user have configured by id

GET /users/current/configuration/strategies/:strategyId

For more information see Swagger documentation

Headers#

Name Type Required Description
auth-token string Yes authorization token. See Authentication & authorization

Path parameters#

Name Type Required Description
strategyId string Yes strategy id

Response#

Responses:

  • 200 - Strategy returned successfully. Response schema: Strategy
  • 401 - Authorization failed. Response schema: Error
  • 404 - Strategy not found. Response schema: Error

Examples#

Example request:

curl -X GET --header 'Accept: application/json' --header 'auth-token: token' 'https://trading-api-v1.agiliumtrade.agiliumtrade.ai/users/current/configuration/strategies/AeRF'

Example response:

{
  "_id": "AeRF",
  "name": "Test strategy",
  "description": "Some useful description about your strategy",
  "positionLifecycle": "netting",
  "skipPendingOrders": true,
  "connectionId": "105646d8-8c97-4d4d-9b74-413bd66cd4ed",
  "commissionScheme": {
    "type": "flat-fee",
    "billingPeriod": "week",
    "commissionRate": 1
  },
  "platformCommissionRate": 1,
  "maxTradeRisk": 0.4,
  "reverse": true,
  "reduceCorrelations": "by-strategy",
  "stopOutRisk": {
    "value": 0.4,
    "startTime": "2020-08-24T00:00:00.000Z"
  },
  "symbolFilter": {
    "included": [
      "EURUSD"
    ]
  },
  "newsFilter": {
    "calendarNewsFilter": {
      "priorities": [
        "election"
      ],
      "closePositionTimeGapInMinutes": 10,
      "openPositionPrecedingTimeGapInMinutes": 20,
      "openPositionFollowingTimeGapInMinutes": 20
    }
  },
  "riskLimits": [
    {
      "type": "daily",
      "applyTo": "balance",
      "maxRisk": 0.4,
      "closePositions": true,
      "startTime": "2020-08-24T00:00:00.000Z"
    }
  ],
  "maxStopLoss": {
    "value": 150,
    "units": "pips"
  },
  "maxLeverage": 50,
  "symbolMapping": [
    {
      "to": "EURUSD",
      "from": "EURUSD.m"
    }
  ],
  "tradeSizeScalingMode": "none",
  "magicFilter": {
    "included": [
      "1000-2000"
    ],
    "excluded": [
      "1250-1500"
    ]
  },
  "timeSettings": {
    "lifetimeInHours": 10,
    "openingIntervalInMinutes": 10
  }
}