Skip to content

Get portfolio strategy by id#

About#

Returns provider portfolio the user have configured by id

GET /users/current/configuration/portfolio-strategies/:portfolioId

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
portfolioId string Yes portfolio id

Response#

Responses:

  • 200 - Portfolio returned successfully. Response schema: PortfolioStrategy
  • 401 - Authorization failed. Response schema: Error
  • 404 - PortfolioStrategy 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/portfolio-strategies/QlX5'

Example response:

{
  "_id": "QlX5",
  "name": "Test strategy",
  "description": "Some useful description about your strategy",
  "members": [
    {
      "strategyId": "Gfdr",
      "multiplier": 1,
      "skipPendingOrders": true,
      "maxTradeRisk": 0.4,
      "reverse": true,
      "reduceCorrelations": "by-strategy",
      "stopOutRisk": {
        "value": 0.7,
        "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.1,
          "closePositions": true,
          "startTime": "2020-08-24T00:00:00.000Z"
        }
      ],
      "maxStopLoss": {
        "value": 100,
        "units": "pips"
      },
      "maxLeverage": 50,
      "symbolMapping": [
        {
          "to": "EURUSD",
          "from": "EURUSD.m"
        }
      ],
      "tradeSizeScalingMode": "none"
    }
  ],
  "commissionScheme": {
    "type": "flat-fee",
    "billingPeriod": "week",
    "commissionRate": 0
  },
  "skipPendingOrders": true,
  "maxTradeRisk": 0.1,
  "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": 10,
      "openPositionFollowingTimeGapInMinutes": 20
    }
  },
  "riskLimits": [
    {
      "type": "daily",
      "applyTo": "balance",
      "maxRisk": 0.1,
      "closePositions": true,
      "startTime": "2020-08-24T00:00:00.000Z"
    }
  ],
  "maxStopLoss": {
    "value": 150,
    "units": "pips"
  },
  "maxLeverage": 50,
  "symbolMapping": [
    {
      "to": "EURUSD",
      "from": "EURUSD.m"
    }
  ],
  "tradeSizeScalingMode": "none",
  "platformCommissionRate": 0
}