Get portfolio strategies

About

Returns provider portfolios the user has configured

GET /users/current/configuration/portfolio-strategies

For more information see Swagger documentation

Headers

Name	Type	Required	Description
auth-token	string	Yes	authorization token. See Authentication & authorization
api-version	number		request version, allowed values are 1 and 2, default is 1

Query parameters

Name	Type	Required	Description
includeRemoved	boolean		flag instructing to include removed portfolio strategies in results, default: false
limit	integer		pagination limit, default: 1000, min: 1, max: 1000
offset	integer		pagination offset, default: 0, min: 0

Response

Responses:

• 200 - Portfolios returned successfully. Response schema: Array<PortfolioStrategy> for request v1 and PortfolioStrategyList for request v2.
• 401 - Authorization failed. Response schema: Error

Examples

Example request:

curl -X GET --header 'Accept: application/json' --header 'auth-token: token' 'https://copyfactory-api-v1.new-york.agiliumtrade.ai/users/current/configuration/portfolio-strategies'

Example response for request v1:

[
  {
    "_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": {
          "absoluteValue": 0.05,
          "relativeValue": 0.7,
          "startTime": "2020-08-24T00:00:00.000Z"
        },
        "symbolFilter": {
          "included": [
            "EURUSD"
          ]
        },
        "newsFilter": {
          "calendarNewsFilter": {
            "priorities": [
              "election"
            ],
            "closePositionTimeGapInMinutes": 10,
            "openPositionPrecedingTimeGapInMinutes": 20,
            "openPositionFollowingTimeGapInMinutes": 20
          }
        },
        "riskLimits": [
          {
            "type": "day",
            "applyTo": "balance-difference",
            "maxAbsoluteRisk": 0.05,
            "maxRelativeRisk": 0.1,
            "closePositions": true,
            "startTime": "2020-08-24T00:00:00.000Z"
          }
        ],
        "maxStopLoss": {
          "value": 100,
          "units": "pips"
        },
        "maxLeverage": 50,
        "symbolMapping": [
          {
            "to": "EURUSD",
            "from": "EURUSD.m"
          }
        ],
        "tradeSizeScaling": {
          "mode": "none"
        },
      }
    ],
    "commissionScheme": {
      "type": "flat-fee",
      "billingPeriod": "week",
      "commissionRate": 0
    },
    "skipPendingOrders": true,
    "maxTradeRisk": 0.1,
    "reverse": true,
    "reduceCorrelations": "by-strategy",
    "stopOutRisk": {
      "absoluteValue": 0.05,
      "relativeValue": 0.4,
      "startTime": "2020-08-24T00:00:00.000Z"
    },
    "symbolFilter": {
      "included": [
        "EURUSD"
      ]
    },
    "newsFilter": {
      "calendarNewsFilter": {
        "priorities": [
          "election"
        ],
        "closePositionTimeGapInMinutes": 10,
        "openPositionPrecedingTimeGapInMinutes": 10,
        "openPositionFollowingTimeGapInMinutes": 20
      }
    },
    "riskLimits": [
      {
        "type": "day",
        "applyTo": "balance-difference",
        "maxAbsoluteRisk": 0.05,
        "maxRelativeRisk": 0.1,
        "closePositions": true,
        "startTime": "2020-08-24T00:00:00.000Z"
      }
    ],
    "maxStopLoss": {
      "value": 150,
      "units": "pips"
    },
    "maxLeverage": 50,
    "symbolMapping": [
      {
        "to": "EURUSD",
        "from": "EURUSD.m"
      }
    ],
    "tradeSizeScaling": {
      "mode": "none"
    },
    "platformCommissionRate": 0
  }
]

Example response for request v2:

{
  "count": 1,
  "items": [
    {
      "_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": {
            "absoluteValue": 0.05,
            "relativeValue": 0.7,
            "startTime": "2020-08-24T00:00:00.000Z"
          },
          "symbolFilter": {
            "included": [
              "EURUSD"
            ]
          },
          "newsFilter": {
            "calendarNewsFilter": {
              "priorities": [
                "election"
              ],
              "closePositionTimeGapInMinutes": 10,
              "openPositionPrecedingTimeGapInMinutes": 20,
              "openPositionFollowingTimeGapInMinutes": 20
            }
          },
          "riskLimits": [
            {
              "type": "day",
              "applyTo": "balance-difference",
              "maxAbsoluteRisk": 0.05,
              "maxRelativeRisk": 0.1,
              "closePositions": true,
              "startTime": "2020-08-24T00:00:00.000Z"
            }
          ],
          "maxStopLoss": {
            "value": 100,
            "units": "pips"
          },
          "maxLeverage": 50,
          "symbolMapping": [
            {
              "to": "EURUSD",
              "from": "EURUSD.m"
            }
          ],
          "tradeSizeScaling": {
            "mode": "none"
          },
        }
      ],
      "commissionScheme": {
        "type": "flat-fee",
        "billingPeriod": "week",
        "commissionRate": 0
      },
      "skipPendingOrders": true,
      "maxTradeRisk": 0.1,
      "reverse": true,
      "reduceCorrelations": "by-strategy",
      "stopOutRisk": {
        "absoluteValue": 0.05,
        "relativeValue": 0.4,
        "startTime": "2020-08-24T00:00:00.000Z"
      },
      "symbolFilter": {
        "included": [
          "EURUSD"
        ]
      },
      "newsFilter": {
        "calendarNewsFilter": {
          "priorities": [
            "election"
          ],
          "closePositionTimeGapInMinutes": 10,
          "openPositionPrecedingTimeGapInMinutes": 10,
          "openPositionFollowingTimeGapInMinutes": 20
        }
      },
      "riskLimits": [
        {
          "type": "day",
          "applyTo": "balance-difference",
          "maxAbsoluteRisk": 0.05,
          "maxRelativeRisk": 0.1,
          "closePositions": true,
          "startTime": "2020-08-24T00:00:00.000Z"
        }
      ],
      "maxStopLoss": {
        "value": 150,
        "units": "pips"
      },
      "maxLeverage": 50,
      "symbolMapping": [
        {
          "to": "EURUSD",
          "from": "EURUSD.m"
        }
      ],
      "tradeSizeScaling": {
        "mode": "none"
      },
      "platformCommissionRate": 0
    }
  ]
}