Skip to content

Subscriber list#

About#

Subscriber list model. Contains subscriber list limited by pagination options and summary count of matched records.

Fields#

Name Type Required Description
count integer Yes Number of subscribers matching query in total
items Array<Subscriber> Yes Subscriber list filtered by query

Example#

{
  "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"
          }
        }
      ]
    }
  ]
}

Usages#