Get subscribers

About

Returns strategy subscribers the current user provides strategies to

GET /users/current/configuration/subscribers

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 subscribers 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 - Strategy subscribers returned successfully. Response schema: Array<Subscriber> for request v1 and SubscriberList 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/subscribers'

Example response for request v1:

[
  {
    "_id": "105646d8-8c97-4d4d-9b74-413bd66cd4ed",
    "name": "Demo subscriber",
    "stopOutRisk": {
      "absoluteValue": 0.05,
      "relativeValue": 0.01,
      "startTime": "2020-08-24T00:00:00.000Z"
    },
    "riskLimits": [
      {
        "type": "day",
        "applyTo": "balance-difference",
        "maxAbsoluteRisk": 0.05,
        "maxRelativeRisk": 0.01,
        "closePositions": true,
        "startTime": "2020-08-24T00:00:00.000Z"
      }
    ],
    "maxLeverage": 50,
    "subscriptions": [
      {
        "strategyId": "SMKn",
        "multiplier": 1,
        "skipPendingOrders": true,
        "closeOnly": "by-strategy",
        "maxTradeRisk": 0.01,
        "reverse": true,
        "reduceCorrelations": "by-strategy",
        "stopOutRisk": {
          "absoluteValue": 0.05,
          "relativeValue": 0.01,
          "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.01,
            "closePositions": true,
            "startTime": "2020-08-24T00:00:00.000Z"
          }
        ],
        "maxStopLoss": {
          "value": 100,
          "units": "pips"
        },
        "maxLeverage": 0,
        "symbolMapping": [
          {
            "to": "AUDUSD",
            "from": "AUDUSD.m"
          }
        ],
        "tradeSizeScaling": {
          "mode": "none"
        }
      }
    ]
  }
]

Example response for request v2:

{
  "count": 1,
  "items": [
    {
      "_id": "105646d8-8c97-4d4d-9b74-413bd66cd4ed",
      "name": "Demo subscriber",
      "stopOutRisk": {
        "absoluteValue": 0.05,
        "relativeValue": 0.01,
        "startTime": "2020-08-24T00:00:00.000Z"
      },
      "riskLimits": [
        {
          "type": "day",
          "applyTo": "balance-difference",
          "maxAbsoluteRisk": 0.05,
          "maxRelativeRisk": 0.01,
          "closePositions": true,
          "startTime": "2020-08-24T00:00:00.000Z"
        }
      ],
      "maxLeverage": 50,
      "subscriptions": [
        {
          "strategyId": "SMKn",
          "multiplier": 1,
          "skipPendingOrders": true,
          "closeOnly": "by-strategy",
          "maxTradeRisk": 0.01,
          "reverse": true,
          "reduceCorrelations": "by-strategy",
          "stopOutRisk": {
            "absoluteValue": 0.05,
            "relativeValue": 0.01,
            "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.01,
              "closePositions": true,
              "startTime": "2020-08-24T00:00:00.000Z"
            }
          ],
          "maxStopLoss": {
            "value": 100,
            "units": "pips"
          },
          "maxLeverage": 0,
          "symbolMapping": [
            {
              "to": "AUDUSD",
              "from": "AUDUSD.m"
            }
          ],
          "tradeSizeScaling": {
            "mode": "none"
          }
        }
      ]
    }
  ]
}