Get Rule Configuration

API URL: GET https://userapi-demo.s2f.projectx.com/AccountTemplateRule/rules/{accountTemplateId}/{ruleId}

API Reference: /AccountTemplateRule/rules/{accountTemplateId}/{ruleId}

Description

---

Retrieves the details of an existing rule.

Parameters

---

Name	Type	Description	Required	Nullable
accountTemplateId	integer	The template id.	true	false
ruleId	integer	The rule Id.	true	false

Example Usage

---

Example Request

Request

cURL

  curl -X 'GET' \
    'https://userapi-demo.s2f.projectx.com/AccountTemplateRule/rules/1/1' \
    -H 'accept: text/plain'

Example Response

Daily Loss Limit

{
  "accountTemplateId": 1,
  "ruleId": 1,
  "configuration": {
      "violationStatus": 1,
      "violationDuration": 2,
      "liquidateFollowers": null,
      "dailyLossLimit": {
          "source": 2,
          "percentage": null,
          "limit": 1000,
          "disableBalanceSource": null,
          "disableCheckSource": null,
          "disablePercentage": null,
          "disableLimit": null,
          "disableMinimumBalanceSource": null,
          "disableMaximumBalanceSource": null
      },
      "maximumLossLimit": null,
      "marginScale": null
  }
}

Maximum Loss Limit

  {
      "accountTemplateId": 1,
      "ruleId": 2,
      "configuration": {
          "violationStatus": 2,
          "violationDuration": 1,
          "liquidateFollowers": null,
          "dailyLossLimit": null,
          "maximumLossLimit": {
              "source": 5,
              "percentage": null,
              "limit": 2000,
              "minimumSource": null,
              "maximumSource": 1,
              "maximumSourceSpecifiedBalance": null
          },
          "marginScale": null
      }
  }