Organization

Create a new trading rule

Create a new trading rule for your organization. **Admin only**. **Required fields:** - `name` - Must be unique within your organization **Optional rule parameters:** | Field | Unit | Description | Example | |-------|------|-------------|---------| | `profitTarget` | $ | Profit target to pass | 4000 | | `dailyProfit` | $ | Max daily profit cap (0 = unlimited) | 0 | | `maxProfit` | $ | Max total profit cap (0 = unlimited) | 0 | | `dailyLoss` | $ | Max loss allowed per day | 1000 | | `maxLoss` | $ | Max total loss from starting balance | 2500 | | `dailyDrawdown` | % | Max drawdown from day's starting balance | 2 | | `maxDrawdown` | % or $ | Max drawdown (unit set by `drawdownDenomination`, reference by `drawdownType`) | 5 | | `drawdownDenomination` | | percent (default) or dollars — dollars is required for zero-based accounts | percent | | `drawdownTrailCeiling` | $ | Trailing floor lock level above initial balance (null = trails forever) | 100 | | `newsTradingAllowed` etc. | bool | Display-only permission flags (news trading, microscalping, weekend/overnight holding) shown to traders; default true, not engine-enforced | true | | `drawdownType` | | How drawdown is calculated (see below) | trailing | | `consistency` | % | Consistency rule (0 = disabled) | 0 | | `maxContracts` | count | Max position size in mini-equivalent contracts | 10 | | `microConversionRatio` | count | Micros per 1 unit toward maxContracts (default 10, see below) | 5 | | `scalingPlan` | | Profit-based contract scaling tiers (see below) | { "tiers": [...] } | | `metadata` | | Custom organization data | { "version": "1.0" } | **Understanding the units:** - **Dollar values ($):** `profitTarget`, `dailyProfit`, `maxProfit`, `dailyLoss`, `maxLoss` — these are absolute dollar amounts relative to the account size. E.g., `maxLoss: 2500` means the trader can lose $2,500. - **Percentage values (%):** `dailyDrawdown`, `consistency` — always percentages. `maxDrawdown` is a percent by default, but becomes a dollar amount when `drawdownDenomination` is `dollars` (how zero-based sim-funded plans express a $1,000 trailing max loss). **Drawdown types (`drawdownType`):** | Value | Description | |-------|-------------| | `static` | Drawdown measured from **initial balance**. Never moves. (default) | | `trailing` | Drawdown trails the **high water mark in real-time**. Updates on every fill. | | `eod` | Same as trailing but only updates at **end of day** (market close). Intraday highs don't move the floor. | **Micro contract conversion (`microConversionRatio`):** `maxContracts` (and scaling-plan tiers) are denominated in mini-equivalent units. Micro contracts (MES, MNQ, MGC, ...) are converted using the rule set's `microConversionRatio` — how many micros count as **1 unit** toward the limit: | Ratio | `maxContracts: 10` allows | |-------|---------------------------| | `10` (default, CME notional ratio) | 10 minis or 100 micros, or any equivalent mix | | `5` | 10 minis or 50 micros | | `1` | 10 contracts total — micros count the same as minis | E-mini and full-size contracts always count as 1 unit each; the ratio only affects micros. Omit the field (or PATCH it to `null`) to use the default 10:1 conversion. Different plans can use different ratios by pointing them at different rule sets. Enforcement is account-wide and real-time in the trade engine. Example — a plan where 5 micros equal 1 mini: ```json { "maxContracts": 10, "microConversionRatio": 5 } ``` **Scaling plans (`scalingPlan`):** ## Position limits: pick the right field `maxContracts` counts **engine units** and a rule is not tied to a market, so one unit is one futures contract but **0.001 BTC** on the Binance perpetual. The same number therefore means different things depending on which account the rule backs. Use `maxPositionByMarket` for anything that is not plain futures: ```json { "name": "50K BTC Perp", "maxLoss": 2000, "dailyLoss": 1000, "maxPositionByMarket": { "BINANCE": 0.5 } } ``` That is **half a Bitcoin** — no conversion, no engine units. Rejections quote it back the same way: > Order would exceed the BINANCE position limit on this account: 0.600 BTC > requested, limit 0.500 BTC. | Field | Counts in | Scope | Use for | |---|---|---|---| | `maxPositionByMarket` | the market's own unit (BTC) | that market only | crypto, and any fractional contract | | `maxContracts` | mini-equivalents (micros via `microConversionRatio`) | all instruments | futures | A market named in `maxPositionByMarket` is **not** also gated by `maxContracts` — a market gets one limit or the other. Send `null` to clear every per-market limit and put all markets back under `maxContracts`. Instead of a flat `maxContracts` limit, you can define profit-based tiers that grow the trader's position size as they make profit: ```json { "scalingPlan": { "basis": "balance", "tiers": [ { "profit": 0, "maxContracts": 1 }, { "profit": 1000, "maxContracts": 2 }, { "profit": 3000, "maxContracts": 5.5 } ] } } ``` - `profit` is in dollars relative to the account's starting balance. The first tier must be `0` — it defines the starting limit. - Alternatively, tiers can use absolute `balance` thresholds instead of `profit` (all tiers must use the same key). The first tier defines the starting limit — set its threshold at (or below) the account size: ```json { "tiers": [ { "balance": 50000, "maxContracts": 1 }, { "balance": 55000, "maxContracts": 2 }, { "balance": 60000, "maxContracts": 5.5 } ] } ``` Note: balance thresholds tie the rule to one account size — a `55000` tier means something very different on a 25K vs 100K account. Profit-based tiers are portable across account sizes; prefer them unless all accounts on this rule share one size. - `maxContracts` is in **mini-equivalent** units and supports **0.1 steps**. Micros count as 1/`microConversionRatio` of a mini (default 10), so `5.5` allows 5 minis or 55 micros (e.g. 5 ES or 55 MES) at the default ratio. - `basis` controls when tiers activate/deactivate: | Value | Behavior | |-------|----------| | `balance` | Measured against current balance — limits scale back down if the balance drops below a threshold (default) | | `high_water_mark` | Measured against the best balance reached — tiers unlock permanently | - When `scalingPlan` is set it **overrides** `maxContracts`. Remove it (`"scalingPlan": null` on PATCH) to fall back to the flat limit. - Enforced in real time at order placement by the trade engine. **Consistency rule (`consistency` + related fields):** Caps how much of a trader's profit may come from a single day. The daily cap is: ```text daily_cap = round(base × consistency%, 2) + starting_balance × consistencyTolerancePct% + consistencyLeniency ``` A day whose net PnL **reaches or exceeds** the cap fails the rule (the boundary is inclusive). The formula is selected automatically by account type: - **Evaluation accounts** — the rule gates *passing*: base defaults to max(profitTarget, totalPnl), and the trader also needs at least `consistencyMinDays` profitable days (default: ceil(100/consistency), so 50% → 2 days). Reaching the profit target with over-concentrated gains does NOT fail the account — it simply stays active until gains are spread out, and the account's `completionPendingReason` explains exactly why. - **Sim-funded accounts** — the rule gates *payouts*: base is the profit in the current payout cycle (since the last payout with `consistencyReset`). **Enforcement is opt-in per rule set** (`consistencyEnforced`, default false — the historical behavior where the consistency % was informational only). Existing accounts are unaffected until you enable it. Example — MFFU-style template: `{ "consistency": 50, "consistencyEnforced": true, "consistencyTolerancePct": 0.2 }` on evaluation rules, and `{ "consistency": 50, "consistencyEnforced": true, "consistencyLeniency": 40 }` on Builder sim-funded rules. **Sim-funded accounts — limits are optional per rule set:** Every trading limit on a rule set applies to `sim_funded` accounts exactly like evaluations **when set**, and is disabled when `0`/omitted — so you choose per template who enforces funded limits: - **Platform enforces** (recommended): attach a rule set with real values, e.g. `{ "dailyLoss": 1500, "maxLoss": 2500, "maxContracts": 5, "consistency": 50, "consistencyEnforced": true, "consistencyLeniency": 40, "maxPayouts": 5, "payoutMllLockOffset": 100 }` — we enforce limits live, gate payouts on consistency, and fire the webhooks. - **You enforce**: attach a permissive rule set (limits `0`) and run your own logic; we still execute trades and payouts. `profitTarget` never completes a sim-funded account — funded accounts withdraw, they don't "pass" — so it is safe to reuse an eval-style rule set on funded accounts. **Example:** ```bash curl -X POST "https://api.example.com/platform/v1/organization/trading-rules" \ -H "X-API-Key: hp_live_your_key_here" \ -H "Content-Type: application/json" \ -d '{ "name": "Aggressive 100K Challenge", "description": "High risk tolerance for experienced traders", "profitTarget": 10000, "maxLoss": 5000, "maxDrawdown": 5000, "dailyLoss": 2500, "maxContracts": 15, "microConversionRatio": 5, "metadata": { "tier": "advanced", "version": "1.0" } }' ``` **Error Codes:** | Code | Description | |------|-------------| | `RULE_NAME_EXISTS` | A rule with this name already exists | | `ADMIN_REQUIRED` | Only admins can create rules |

POST

organization

trading-rules

curl --request POST \
  --url https://api.hyperprop.com/platform/v1/organization/trading-rules \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Aggressive 100K Challenge",
  "description": "High risk tolerance rules for experienced traders",
  "profitTarget": 10000,
  "dailyProfit": 0,
  "maxProfit": 0,
  "dailyLoss": 2500,
  "maxLoss": 5000,
  "dailyDrawdown": 2500,
  "maxDrawdown": 5,
  "drawdownType": "trailing",
  "drawdownDenomination": "percent",
  "drawdownTrailCeiling": 100,
  "newsTradingAllowed": true,
  "microscalpingAllowed": true,
  "weekendHoldingAllowed": true,
  "overnightHoldingAllowed": true,
  "consistency": 30,
  "consistencyEnforced": true,
  "consistencyBase": "max_target_or_pnl",
  "consistencyTolerancePct": 0.2,
  "consistencyLeniency": 40,
  "consistencyMinDays": 2,
  "consistencyProfitableDayMin": 0,
  "maxPayouts": 5,
  "payoutMllLockOffset": 100,
  "maxPositionByMarket": {
    "BINANCE": 0.5
  },
  "maxContracts": 10,
  "microConversionRatio": 10,
  "scalingPlan": {
    "basis": "balance",
    "tiers": [
      {
        "profit": 0,
        "maxContracts": 1
      },
      {
        "profit": 1000,
        "maxContracts": 2
      },
      {
        "profit": 3000,
        "maxContracts": 5.5
      }
    ]
  },
  "personalRiskPolicy": {
    "dailyLossLimitMax": 1000,
    "dailyLossLimitDefault": 500,
    "requireDailyLossLimit": true,
    "maxTradesPerDayMax": 20
  },
  "metadata": {
    "ruleVersion": "1.0",
    "market": "futures",
    "weekendHoldingAllowed": false
  }
}
'

import requests

url = "https://api.hyperprop.com/platform/v1/organization/trading-rules"

payload = {
    "name": "Aggressive 100K Challenge",
    "description": "High risk tolerance rules for experienced traders",
    "profitTarget": 10000,
    "dailyProfit": 0,
    "maxProfit": 0,
    "dailyLoss": 2500,
    "maxLoss": 5000,
    "dailyDrawdown": 2500,
    "maxDrawdown": 5,
    "drawdownType": "trailing",
    "drawdownDenomination": "percent",
    "drawdownTrailCeiling": 100,
    "newsTradingAllowed": True,
    "microscalpingAllowed": True,
    "weekendHoldingAllowed": True,
    "overnightHoldingAllowed": True,
    "consistency": 30,
    "consistencyEnforced": True,
    "consistencyBase": "max_target_or_pnl",
    "consistencyTolerancePct": 0.2,
    "consistencyLeniency": 40,
    "consistencyMinDays": 2,
    "consistencyProfitableDayMin": 0,
    "maxPayouts": 5,
    "payoutMllLockOffset": 100,
    "maxPositionByMarket": { "BINANCE": 0.5 },
    "maxContracts": 10,
    "microConversionRatio": 10,
    "scalingPlan": {
        "basis": "balance",
        "tiers": [
            {
                "profit": 0,
                "maxContracts": 1
            },
            {
                "profit": 1000,
                "maxContracts": 2
            },
            {
                "profit": 3000,
                "maxContracts": 5.5
            }
        ]
    },
    "personalRiskPolicy": {
        "dailyLossLimitMax": 1000,
        "dailyLossLimitDefault": 500,
        "requireDailyLossLimit": True,
        "maxTradesPerDayMax": 20
    },
    "metadata": {
        "ruleVersion": "1.0",
        "market": "futures",
        "weekendHoldingAllowed": False
    }
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Aggressive 100K Challenge',
    description: 'High risk tolerance rules for experienced traders',
    profitTarget: 10000,
    dailyProfit: 0,
    maxProfit: 0,
    dailyLoss: 2500,
    maxLoss: 5000,
    dailyDrawdown: 2500,
    maxDrawdown: 5,
    drawdownType: 'trailing',
    drawdownDenomination: 'percent',
    drawdownTrailCeiling: 100,
    newsTradingAllowed: true,
    microscalpingAllowed: true,
    weekendHoldingAllowed: true,
    overnightHoldingAllowed: true,
    consistency: 30,
    consistencyEnforced: true,
    consistencyBase: 'max_target_or_pnl',
    consistencyTolerancePct: 0.2,
    consistencyLeniency: 40,
    consistencyMinDays: 2,
    consistencyProfitableDayMin: 0,
    maxPayouts: 5,
    payoutMllLockOffset: 100,
    maxPositionByMarket: {BINANCE: 0.5},
    maxContracts: 10,
    microConversionRatio: 10,
    scalingPlan: {
      basis: 'balance',
      tiers: [
        {profit: 0, maxContracts: 1},
        {profit: 1000, maxContracts: 2},
        {profit: 3000, maxContracts: 5.5}
      ]
    },
    personalRiskPolicy: {
      dailyLossLimitMax: 1000,
      dailyLossLimitDefault: 500,
      requireDailyLossLimit: true,
      maxTradesPerDayMax: 20
    },
    metadata: {ruleVersion: '1.0', market: 'futures', weekendHoldingAllowed: false}
  })
};

fetch('https://api.hyperprop.com/platform/v1/organization/trading-rules', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hyperprop.com/platform/v1/organization/trading-rules",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Aggressive 100K Challenge',
    'description' => 'High risk tolerance rules for experienced traders',
    'profitTarget' => 10000,
    'dailyProfit' => 0,
    'maxProfit' => 0,
    'dailyLoss' => 2500,
    'maxLoss' => 5000,
    'dailyDrawdown' => 2500,
    'maxDrawdown' => 5,
    'drawdownType' => 'trailing',
    'drawdownDenomination' => 'percent',
    'drawdownTrailCeiling' => 100,
    'newsTradingAllowed' => true,
    'microscalpingAllowed' => true,
    'weekendHoldingAllowed' => true,
    'overnightHoldingAllowed' => true,
    'consistency' => 30,
    'consistencyEnforced' => true,
    'consistencyBase' => 'max_target_or_pnl',
    'consistencyTolerancePct' => 0.2,
    'consistencyLeniency' => 40,
    'consistencyMinDays' => 2,
    'consistencyProfitableDayMin' => 0,
    'maxPayouts' => 5,
    'payoutMllLockOffset' => 100,
    'maxPositionByMarket' => [
        'BINANCE' => 0.5
    ],
    'maxContracts' => 10,
    'microConversionRatio' => 10,
    'scalingPlan' => [
        'basis' => 'balance',
        'tiers' => [
                [
                                'profit' => 0,
                                'maxContracts' => 1
                ],
                [
                                'profit' => 1000,
                                'maxContracts' => 2
                ],
                [
                                'profit' => 3000,
                                'maxContracts' => 5.5
                ]
        ]
    ],
    'personalRiskPolicy' => [
        'dailyLossLimitMax' => 1000,
        'dailyLossLimitDefault' => 500,
        'requireDailyLossLimit' => true,
        'maxTradesPerDayMax' => 20
    ],
    'metadata' => [
        'ruleVersion' => '1.0',
        'market' => 'futures',
        'weekendHoldingAllowed' => false
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hyperprop.com/platform/v1/organization/trading-rules"

	payload := strings.NewReader("{\n  \"name\": \"Aggressive 100K Challenge\",\n  \"description\": \"High risk tolerance rules for experienced traders\",\n  \"profitTarget\": 10000,\n  \"dailyProfit\": 0,\n  \"maxProfit\": 0,\n  \"dailyLoss\": 2500,\n  \"maxLoss\": 5000,\n  \"dailyDrawdown\": 2500,\n  \"maxDrawdown\": 5,\n  \"drawdownType\": \"trailing\",\n  \"drawdownDenomination\": \"percent\",\n  \"drawdownTrailCeiling\": 100,\n  \"newsTradingAllowed\": true,\n  \"microscalpingAllowed\": true,\n  \"weekendHoldingAllowed\": true,\n  \"overnightHoldingAllowed\": true,\n  \"consistency\": 30,\n  \"consistencyEnforced\": true,\n  \"consistencyBase\": \"max_target_or_pnl\",\n  \"consistencyTolerancePct\": 0.2,\n  \"consistencyLeniency\": 40,\n  \"consistencyMinDays\": 2,\n  \"consistencyProfitableDayMin\": 0,\n  \"maxPayouts\": 5,\n  \"payoutMllLockOffset\": 100,\n  \"maxPositionByMarket\": {\n    \"BINANCE\": 0.5\n  },\n  \"maxContracts\": 10,\n  \"microConversionRatio\": 10,\n  \"scalingPlan\": {\n    \"basis\": \"balance\",\n    \"tiers\": [\n      {\n        \"profit\": 0,\n        \"maxContracts\": 1\n      },\n      {\n        \"profit\": 1000,\n        \"maxContracts\": 2\n      },\n      {\n        \"profit\": 3000,\n        \"maxContracts\": 5.5\n      }\n    ]\n  },\n  \"personalRiskPolicy\": {\n    \"dailyLossLimitMax\": 1000,\n    \"dailyLossLimitDefault\": 500,\n    \"requireDailyLossLimit\": true,\n    \"maxTradesPerDayMax\": 20\n  },\n  \"metadata\": {\n    \"ruleVersion\": \"1.0\",\n    \"market\": \"futures\",\n    \"weekendHoldingAllowed\": false\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.hyperprop.com/platform/v1/organization/trading-rules")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Aggressive 100K Challenge\",\n  \"description\": \"High risk tolerance rules for experienced traders\",\n  \"profitTarget\": 10000,\n  \"dailyProfit\": 0,\n  \"maxProfit\": 0,\n  \"dailyLoss\": 2500,\n  \"maxLoss\": 5000,\n  \"dailyDrawdown\": 2500,\n  \"maxDrawdown\": 5,\n  \"drawdownType\": \"trailing\",\n  \"drawdownDenomination\": \"percent\",\n  \"drawdownTrailCeiling\": 100,\n  \"newsTradingAllowed\": true,\n  \"microscalpingAllowed\": true,\n  \"weekendHoldingAllowed\": true,\n  \"overnightHoldingAllowed\": true,\n  \"consistency\": 30,\n  \"consistencyEnforced\": true,\n  \"consistencyBase\": \"max_target_or_pnl\",\n  \"consistencyTolerancePct\": 0.2,\n  \"consistencyLeniency\": 40,\n  \"consistencyMinDays\": 2,\n  \"consistencyProfitableDayMin\": 0,\n  \"maxPayouts\": 5,\n  \"payoutMllLockOffset\": 100,\n  \"maxPositionByMarket\": {\n    \"BINANCE\": 0.5\n  },\n  \"maxContracts\": 10,\n  \"microConversionRatio\": 10,\n  \"scalingPlan\": {\n    \"basis\": \"balance\",\n    \"tiers\": [\n      {\n        \"profit\": 0,\n        \"maxContracts\": 1\n      },\n      {\n        \"profit\": 1000,\n        \"maxContracts\": 2\n      },\n      {\n        \"profit\": 3000,\n        \"maxContracts\": 5.5\n      }\n    ]\n  },\n  \"personalRiskPolicy\": {\n    \"dailyLossLimitMax\": 1000,\n    \"dailyLossLimitDefault\": 500,\n    \"requireDailyLossLimit\": true,\n    \"maxTradesPerDayMax\": 20\n  },\n  \"metadata\": {\n    \"ruleVersion\": \"1.0\",\n    \"market\": \"futures\",\n    \"weekendHoldingAllowed\": false\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hyperprop.com/platform/v1/organization/trading-rules")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Aggressive 100K Challenge\",\n  \"description\": \"High risk tolerance rules for experienced traders\",\n  \"profitTarget\": 10000,\n  \"dailyProfit\": 0,\n  \"maxProfit\": 0,\n  \"dailyLoss\": 2500,\n  \"maxLoss\": 5000,\n  \"dailyDrawdown\": 2500,\n  \"maxDrawdown\": 5,\n  \"drawdownType\": \"trailing\",\n  \"drawdownDenomination\": \"percent\",\n  \"drawdownTrailCeiling\": 100,\n  \"newsTradingAllowed\": true,\n  \"microscalpingAllowed\": true,\n  \"weekendHoldingAllowed\": true,\n  \"overnightHoldingAllowed\": true,\n  \"consistency\": 30,\n  \"consistencyEnforced\": true,\n  \"consistencyBase\": \"max_target_or_pnl\",\n  \"consistencyTolerancePct\": 0.2,\n  \"consistencyLeniency\": 40,\n  \"consistencyMinDays\": 2,\n  \"consistencyProfitableDayMin\": 0,\n  \"maxPayouts\": 5,\n  \"payoutMllLockOffset\": 100,\n  \"maxPositionByMarket\": {\n    \"BINANCE\": 0.5\n  },\n  \"maxContracts\": 10,\n  \"microConversionRatio\": 10,\n  \"scalingPlan\": {\n    \"basis\": \"balance\",\n    \"tiers\": [\n      {\n        \"profit\": 0,\n        \"maxContracts\": 1\n      },\n      {\n        \"profit\": 1000,\n        \"maxContracts\": 2\n      },\n      {\n        \"profit\": 3000,\n        \"maxContracts\": 5.5\n      }\n    ]\n  },\n  \"personalRiskPolicy\": {\n    \"dailyLossLimitMax\": 1000,\n    \"dailyLossLimitDefault\": 500,\n    \"requireDailyLossLimit\": true,\n    \"maxTradesPerDayMax\": 20\n  },\n  \"metadata\": {\n    \"ruleVersion\": \"1.0\",\n    \"market\": \"futures\",\n    \"weekendHoldingAllowed\": false\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "Trading rule created successfully",
  "data": {
    "id": "660e8400-e29b-41d4-a716-446655440000",
    "name": "MFFU-style 50K Rules",
    "profitTarget": 3000,
    "maxLoss": 2500,
    "maxDrawdown": 0,
    "drawdownType": "static",
    "consistency": 50,
    "consistencyEnforced": true,
    "consistencyBase": null,
    "consistencyTolerancePct": 0.2,
    "consistencyLeniency": 0,
    "consistencyMinDays": null,
    "consistencyProfitableDayMin": 0,
    "maxPayouts": null,
    "payoutMllLockOffset": 100,
    "metadata": {
      "tier": "advanced",
      "market": "futures"
    },
    "createdAt": "2026-02-18T21:19:56.853Z"
  }
}

{
  "success": false,
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Invalid request data",
  "code": "BAD_REQUEST"
}

{
  "success": false,
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Authentication required",
  "code": "UNAUTHORIZED"
}

{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Admin access required",
  "code": "ADMIN_REQUIRED"
}

{
  "statusCode": 409,
  "error": "Conflict",
  "message": "A trading rule with this name already exists",
  "code": "RULE_NAME_EXISTS"
}

{
  "success": false,
  "statusCode": 500,
  "error": "Internal Server Error",
  "message": "An unexpected error occurred",
  "code": "INTERNAL_ERROR"
}

Authorizations

Authorization

string

header

required

JWT Bearer token for user session auth. Format: "Bearer {token}". Used by User and Organization endpoints.

Body

application/json

name

string

required

Rule name (must be unique within your organization)

Example:

"Aggressive 100K Challenge"

description

string

Rule description

Example:

"High risk tolerance rules for experienced traders"

profitTarget

number

Profit target to pass ($)

Example:

10000

dailyProfit

number

Max daily profit cap (0 = unlimited)

Example:

0

maxProfit

number

Max total profit cap (0 = unlimited)

Example:

0

dailyLoss

number

Max loss allowed per day ($)

Example:

2500

maxLoss

number

Max total loss from starting balance ($)

Example:

5000

dailyDrawdown

number

Max drawdown from day's starting balance ($)

Example:

2500

maxDrawdown

number

Max drawdown from the reference. Percent of the reference by default (must be <= 100); a fixed dollar amount when drawdownDenomination is "dollars".

Required range: x >= 0

Example:

5

drawdownType

enum<string>

default:static

How drawdown is calculated. "static" = fixed from initial balance. "trailing" = real-time from high water mark. "eod" = trailing but only updates at end of day.

Available options:

static,

trailing,

eod

Example:

"trailing"

drawdownDenomination

enum<string>

Unit of maxDrawdown. "percent" (default) = % of the reference. "dollars" = a fixed dollar amount below the reference — required for zero-based (e.g. $0 sim funded) accounts, where any percent of $0 is a $0 floor. Example: drawdownType "trailing" + denomination "dollars" + maxDrawdown 1000 = a $1,000 trailing max loss whose floor starts at -$1,000.

Available options:

percent,

dollars

Example:

"percent"

drawdownTrailCeiling

number

For trailing drawdowns: the floor stops climbing once it reaches initialBalance + this many dollars and locks there (the "ceiling"). Example: 100 on a $0 sim funded locks the floor at +$100 once equity has peaked $1,100. null/absent = the floor trails forever.

Example:

100

newsTradingAllowed

boolean

Display-only permission flag shown to traders: trading during news events (default true). Not engine-enforced.

Example:

true

microscalpingAllowed

boolean

Display-only permission flag shown to traders: microscalping (default true). Not engine-enforced.

Example:

true

weekendHoldingAllowed

boolean

Display-only permission flag shown to traders: holding positions over the weekend (default true). Not engine-enforced.

Example:

true

overnightHoldingAllowed

boolean

Display-only permission flag shown to traders: holding positions overnight (default true). Not engine-enforced.

Example:

true

consistency

number

Consistency rule % — max share of profit any single day may reach (0 = disabled). See the consistency notes for the full formula and companion fields.

Example:

30

consistencyEnforced

boolean

Opt-in enforcement switch. false (default) = consistency % is informational only. true = the engine gates evaluation completion (evaluation accounts) or payout eligibility (sim_funded accounts) on the consistency rule.

Example:

true

consistencyBase

enum<string>

What the consistency % applies to. null (default) = automatic by account type: evaluation → max_target_or_pnl (cap grows once total PnL exceeds the target), sim_funded → cycle_profit (profit since the last consistency reset). max_profit_target_or_pnl is accepted as an alias of max_target_or_pnl.

Available options:

max_target_or_pnl,

max_profit_target_or_pnl,

total_pnl,

profit_target,

cycle_profit

Example:

"max_target_or_pnl"

consistencyTolerancePct

number

Daily-cap buffer as a percent of starting balance, added on top of base × consistency%. Example: 0.2 = $100 buffer on a $50,000 account.

Required range: x >= 0

Example:

0.2

consistencyLeniency

number

Flat dollar buffer added to the daily cap (e.g. 40 = $40 leniency on funded payout consistency).

Required range: x >= 0

Example:

40

consistencyMinDays

integer

Minimum profitable days required to pass an evaluation. null (default) = automatic ceil(100 / consistency), e.g. 50% → 2 days, 40% → 3 days. 0 = disabled.

Required range: x >= 0

Example:

2

consistencyProfitableDayMin

number

A trading day counts as profitable when its net PnL is at least this many dollars. Default 0 (any non-negative traded day counts).

Required range: x >= 0

Example:

0

maxPayouts

integer

When set, the Nth processed payout fires the account.max_payouts_reached webhook (e.g. "trader goes live after 5 payouts"). null = unlimited.

Required range: x >= 1

Example:

5

payoutMllLockOffset

number

Default loss-floor offset used by payouts requesting move_mll_to_lock: floor = initial balance + offset. Can be overridden per payout with lockBalance.

Required range: x >= 0

Example:

100

maxPositionByMarket

object

Per-market position limits in each market's own unit — {"BINANCE": 0.5} is half a Bitcoin, not 500 of anything. A market listed here is measured against this limit instead of maxContracts, so it is never gated twice; markets left out fall back to maxContracts in mini-equivalents. Prefer this over maxContracts for any market whose contract steps fractionally.

Example:

{ "BINANCE": 0.5 }

maxContracts

number

Max position size in mini-equivalent contracts (micros converted via microConversionRatio). A rule is not tied to a market, so this is always counted in ENGINE units: one unit is one futures contract, but 0.001 BTC on the Binance perpetual. A 0.1 BTC cap is therefore 100, and 1 BTC is 1000. Read quantityStep on the contract to convert.

Example:

10

microConversionRatio

integer

How many micro contracts (MES, MNQ, ...) count as 1 unit toward maxContracts. Default 10 (CME notional ratio). Use 5 for 5-micros-per-mini plans, or 1 to count micros the same as minis.

Required range: x >= 1

Example:

10

scalingPlan

object

Profit-based contract scaling tiers. Overrides maxContracts when set (see notes).

Show child attributes

Example:

{
  "basis": "balance",
  "tiers": [
    { "profit": 0, "maxContracts": 1 },
    { "profit": 1000, "maxContracts": 2 },
    { "profit": 3000, "maxContracts": 5.5 }
  ]
}

personalRiskPolicy

object

Bounds on the risk controls traders set for themselves on accounts using this rule set (see notes). Omit to leave traders unconstrained.

Show child attributes

Example:

{
  "dailyLossLimitMax": 1000,
  "dailyLossLimitDefault": 500,
  "requireDailyLossLimit": true,
  "maxTradesPerDayMax": 20
}

metadata

object

Custom metadata for your organization

Example:

{
  "ruleVersion": "1.0",
  "market": "futures",
  "weekendHoldingAllowed": false
}

Response

Rule created successfully

success

boolean

Example:

true

message

string

Example:

"Trading rule created successfully"

data

object

Show child attributes

Example:

{
  "id": "660e8400-e29b-41d4-a716-446655440000",
  "name": "MFFU-style 50K Rules",
  "profitTarget": 3000,
  "maxLoss": 2500,
  "maxDrawdown": 0,
  "drawdownType": "static",
  "consistency": 50,
  "consistencyEnforced": true,
  "consistencyBase": null,
  "consistencyTolerancePct": 0.2,
  "consistencyLeniency": 0,
  "consistencyMinDays": null,
  "consistencyProfitableDayMin": 0,
  "maxPayouts": null,
  "payoutMllLockOffset": 100,
  "metadata": { "tier": "advanced", "market": "futures" },
  "createdAt": "2026-02-18T21:19:56.853Z"
}

⌘I

Create a new trading rule

curl --request POST \
  --url https://api.hyperprop.com/platform/v1/organization/trading-rules \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Aggressive 100K Challenge",
  "description": "High risk tolerance rules for experienced traders",
  "profitTarget": 10000,
  "dailyProfit": 0,
  "maxProfit": 0,
  "dailyLoss": 2500,
  "maxLoss": 5000,
  "dailyDrawdown": 2500,
  "maxDrawdown": 5,
  "drawdownType": "trailing",
  "drawdownDenomination": "percent",
  "drawdownTrailCeiling": 100,
  "newsTradingAllowed": true,
  "microscalpingAllowed": true,
  "weekendHoldingAllowed": true,
  "overnightHoldingAllowed": true,
  "consistency": 30,
  "consistencyEnforced": true,
  "consistencyBase": "max_target_or_pnl",
  "consistencyTolerancePct": 0.2,
  "consistencyLeniency": 40,
  "consistencyMinDays": 2,
  "consistencyProfitableDayMin": 0,
  "maxPayouts": 5,
  "payoutMllLockOffset": 100,
  "maxPositionByMarket": {
    "BINANCE": 0.5
  },
  "maxContracts": 10,
  "microConversionRatio": 10,
  "scalingPlan": {
    "basis": "balance",
    "tiers": [
      {
        "profit": 0,
        "maxContracts": 1
      },
      {
        "profit": 1000,
        "maxContracts": 2
      },
      {
        "profit": 3000,
        "maxContracts": 5.5
      }
    ]
  },
  "personalRiskPolicy": {
    "dailyLossLimitMax": 1000,
    "dailyLossLimitDefault": 500,
    "requireDailyLossLimit": true,
    "maxTradesPerDayMax": 20
  },
  "metadata": {
    "ruleVersion": "1.0",
    "market": "futures",
    "weekendHoldingAllowed": false
  }
}
'

import requests

url = "https://api.hyperprop.com/platform/v1/organization/trading-rules"

payload = {
    "name": "Aggressive 100K Challenge",
    "description": "High risk tolerance rules for experienced traders",
    "profitTarget": 10000,
    "dailyProfit": 0,
    "maxProfit": 0,
    "dailyLoss": 2500,
    "maxLoss": 5000,
    "dailyDrawdown": 2500,
    "maxDrawdown": 5,
    "drawdownType": "trailing",
    "drawdownDenomination": "percent",
    "drawdownTrailCeiling": 100,
    "newsTradingAllowed": True,
    "microscalpingAllowed": True,
    "weekendHoldingAllowed": True,
    "overnightHoldingAllowed": True,
    "consistency": 30,
    "consistencyEnforced": True,
    "consistencyBase": "max_target_or_pnl",
    "consistencyTolerancePct": 0.2,
    "consistencyLeniency": 40,
    "consistencyMinDays": 2,
    "consistencyProfitableDayMin": 0,
    "maxPayouts": 5,
    "payoutMllLockOffset": 100,
    "maxPositionByMarket": { "BINANCE": 0.5 },
    "maxContracts": 10,
    "microConversionRatio": 10,
    "scalingPlan": {
        "basis": "balance",
        "tiers": [
            {
                "profit": 0,
                "maxContracts": 1
            },
            {
                "profit": 1000,
                "maxContracts": 2
            },
            {
                "profit": 3000,
                "maxContracts": 5.5
            }
        ]
    },
    "personalRiskPolicy": {
        "dailyLossLimitMax": 1000,
        "dailyLossLimitDefault": 500,
        "requireDailyLossLimit": True,
        "maxTradesPerDayMax": 20
    },
    "metadata": {
        "ruleVersion": "1.0",
        "market": "futures",
        "weekendHoldingAllowed": False
    }
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Aggressive 100K Challenge',
    description: 'High risk tolerance rules for experienced traders',
    profitTarget: 10000,
    dailyProfit: 0,
    maxProfit: 0,
    dailyLoss: 2500,
    maxLoss: 5000,
    dailyDrawdown: 2500,
    maxDrawdown: 5,
    drawdownType: 'trailing',
    drawdownDenomination: 'percent',
    drawdownTrailCeiling: 100,
    newsTradingAllowed: true,
    microscalpingAllowed: true,
    weekendHoldingAllowed: true,
    overnightHoldingAllowed: true,
    consistency: 30,
    consistencyEnforced: true,
    consistencyBase: 'max_target_or_pnl',
    consistencyTolerancePct: 0.2,
    consistencyLeniency: 40,
    consistencyMinDays: 2,
    consistencyProfitableDayMin: 0,
    maxPayouts: 5,
    payoutMllLockOffset: 100,
    maxPositionByMarket: {BINANCE: 0.5},
    maxContracts: 10,
    microConversionRatio: 10,
    scalingPlan: {
      basis: 'balance',
      tiers: [
        {profit: 0, maxContracts: 1},
        {profit: 1000, maxContracts: 2},
        {profit: 3000, maxContracts: 5.5}
      ]
    },
    personalRiskPolicy: {
      dailyLossLimitMax: 1000,
      dailyLossLimitDefault: 500,
      requireDailyLossLimit: true,
      maxTradesPerDayMax: 20
    },
    metadata: {ruleVersion: '1.0', market: 'futures', weekendHoldingAllowed: false}
  })
};

fetch('https://api.hyperprop.com/platform/v1/organization/trading-rules', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hyperprop.com/platform/v1/organization/trading-rules",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Aggressive 100K Challenge',
    'description' => 'High risk tolerance rules for experienced traders',
    'profitTarget' => 10000,
    'dailyProfit' => 0,
    'maxProfit' => 0,
    'dailyLoss' => 2500,
    'maxLoss' => 5000,
    'dailyDrawdown' => 2500,
    'maxDrawdown' => 5,
    'drawdownType' => 'trailing',
    'drawdownDenomination' => 'percent',
    'drawdownTrailCeiling' => 100,
    'newsTradingAllowed' => true,
    'microscalpingAllowed' => true,
    'weekendHoldingAllowed' => true,
    'overnightHoldingAllowed' => true,
    'consistency' => 30,
    'consistencyEnforced' => true,
    'consistencyBase' => 'max_target_or_pnl',
    'consistencyTolerancePct' => 0.2,
    'consistencyLeniency' => 40,
    'consistencyMinDays' => 2,
    'consistencyProfitableDayMin' => 0,
    'maxPayouts' => 5,
    'payoutMllLockOffset' => 100,
    'maxPositionByMarket' => [
        'BINANCE' => 0.5
    ],
    'maxContracts' => 10,
    'microConversionRatio' => 10,
    'scalingPlan' => [
        'basis' => 'balance',
        'tiers' => [
                [
                                'profit' => 0,
                                'maxContracts' => 1
                ],
                [
                                'profit' => 1000,
                                'maxContracts' => 2
                ],
                [
                                'profit' => 3000,
                                'maxContracts' => 5.5
                ]
        ]
    ],
    'personalRiskPolicy' => [
        'dailyLossLimitMax' => 1000,
        'dailyLossLimitDefault' => 500,
        'requireDailyLossLimit' => true,
        'maxTradesPerDayMax' => 20
    ],
    'metadata' => [
        'ruleVersion' => '1.0',
        'market' => 'futures',
        'weekendHoldingAllowed' => false
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hyperprop.com/platform/v1/organization/trading-rules"

	payload := strings.NewReader("{\n  \"name\": \"Aggressive 100K Challenge\",\n  \"description\": \"High risk tolerance rules for experienced traders\",\n  \"profitTarget\": 10000,\n  \"dailyProfit\": 0,\n  \"maxProfit\": 0,\n  \"dailyLoss\": 2500,\n  \"maxLoss\": 5000,\n  \"dailyDrawdown\": 2500,\n  \"maxDrawdown\": 5,\n  \"drawdownType\": \"trailing\",\n  \"drawdownDenomination\": \"percent\",\n  \"drawdownTrailCeiling\": 100,\n  \"newsTradingAllowed\": true,\n  \"microscalpingAllowed\": true,\n  \"weekendHoldingAllowed\": true,\n  \"overnightHoldingAllowed\": true,\n  \"consistency\": 30,\n  \"consistencyEnforced\": true,\n  \"consistencyBase\": \"max_target_or_pnl\",\n  \"consistencyTolerancePct\": 0.2,\n  \"consistencyLeniency\": 40,\n  \"consistencyMinDays\": 2,\n  \"consistencyProfitableDayMin\": 0,\n  \"maxPayouts\": 5,\n  \"payoutMllLockOffset\": 100,\n  \"maxPositionByMarket\": {\n    \"BINANCE\": 0.5\n  },\n  \"maxContracts\": 10,\n  \"microConversionRatio\": 10,\n  \"scalingPlan\": {\n    \"basis\": \"balance\",\n    \"tiers\": [\n      {\n        \"profit\": 0,\n        \"maxContracts\": 1\n      },\n      {\n        \"profit\": 1000,\n        \"maxContracts\": 2\n      },\n      {\n        \"profit\": 3000,\n        \"maxContracts\": 5.5\n      }\n    ]\n  },\n  \"personalRiskPolicy\": {\n    \"dailyLossLimitMax\": 1000,\n    \"dailyLossLimitDefault\": 500,\n    \"requireDailyLossLimit\": true,\n    \"maxTradesPerDayMax\": 20\n  },\n  \"metadata\": {\n    \"ruleVersion\": \"1.0\",\n    \"market\": \"futures\",\n    \"weekendHoldingAllowed\": false\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.hyperprop.com/platform/v1/organization/trading-rules")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Aggressive 100K Challenge\",\n  \"description\": \"High risk tolerance rules for experienced traders\",\n  \"profitTarget\": 10000,\n  \"dailyProfit\": 0,\n  \"maxProfit\": 0,\n  \"dailyLoss\": 2500,\n  \"maxLoss\": 5000,\n  \"dailyDrawdown\": 2500,\n  \"maxDrawdown\": 5,\n  \"drawdownType\": \"trailing\",\n  \"drawdownDenomination\": \"percent\",\n  \"drawdownTrailCeiling\": 100,\n  \"newsTradingAllowed\": true,\n  \"microscalpingAllowed\": true,\n  \"weekendHoldingAllowed\": true,\n  \"overnightHoldingAllowed\": true,\n  \"consistency\": 30,\n  \"consistencyEnforced\": true,\n  \"consistencyBase\": \"max_target_or_pnl\",\n  \"consistencyTolerancePct\": 0.2,\n  \"consistencyLeniency\": 40,\n  \"consistencyMinDays\": 2,\n  \"consistencyProfitableDayMin\": 0,\n  \"maxPayouts\": 5,\n  \"payoutMllLockOffset\": 100,\n  \"maxPositionByMarket\": {\n    \"BINANCE\": 0.5\n  },\n  \"maxContracts\": 10,\n  \"microConversionRatio\": 10,\n  \"scalingPlan\": {\n    \"basis\": \"balance\",\n    \"tiers\": [\n      {\n        \"profit\": 0,\n        \"maxContracts\": 1\n      },\n      {\n        \"profit\": 1000,\n        \"maxContracts\": 2\n      },\n      {\n        \"profit\": 3000,\n        \"maxContracts\": 5.5\n      }\n    ]\n  },\n  \"personalRiskPolicy\": {\n    \"dailyLossLimitMax\": 1000,\n    \"dailyLossLimitDefault\": 500,\n    \"requireDailyLossLimit\": true,\n    \"maxTradesPerDayMax\": 20\n  },\n  \"metadata\": {\n    \"ruleVersion\": \"1.0\",\n    \"market\": \"futures\",\n    \"weekendHoldingAllowed\": false\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hyperprop.com/platform/v1/organization/trading-rules")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Aggressive 100K Challenge\",\n  \"description\": \"High risk tolerance rules for experienced traders\",\n  \"profitTarget\": 10000,\n  \"dailyProfit\": 0,\n  \"maxProfit\": 0,\n  \"dailyLoss\": 2500,\n  \"maxLoss\": 5000,\n  \"dailyDrawdown\": 2500,\n  \"maxDrawdown\": 5,\n  \"drawdownType\": \"trailing\",\n  \"drawdownDenomination\": \"percent\",\n  \"drawdownTrailCeiling\": 100,\n  \"newsTradingAllowed\": true,\n  \"microscalpingAllowed\": true,\n  \"weekendHoldingAllowed\": true,\n  \"overnightHoldingAllowed\": true,\n  \"consistency\": 30,\n  \"consistencyEnforced\": true,\n  \"consistencyBase\": \"max_target_or_pnl\",\n  \"consistencyTolerancePct\": 0.2,\n  \"consistencyLeniency\": 40,\n  \"consistencyMinDays\": 2,\n  \"consistencyProfitableDayMin\": 0,\n  \"maxPayouts\": 5,\n  \"payoutMllLockOffset\": 100,\n  \"maxPositionByMarket\": {\n    \"BINANCE\": 0.5\n  },\n  \"maxContracts\": 10,\n  \"microConversionRatio\": 10,\n  \"scalingPlan\": {\n    \"basis\": \"balance\",\n    \"tiers\": [\n      {\n        \"profit\": 0,\n        \"maxContracts\": 1\n      },\n      {\n        \"profit\": 1000,\n        \"maxContracts\": 2\n      },\n      {\n        \"profit\": 3000,\n        \"maxContracts\": 5.5\n      }\n    ]\n  },\n  \"personalRiskPolicy\": {\n    \"dailyLossLimitMax\": 1000,\n    \"dailyLossLimitDefault\": 500,\n    \"requireDailyLossLimit\": true,\n    \"maxTradesPerDayMax\": 20\n  },\n  \"metadata\": {\n    \"ruleVersion\": \"1.0\",\n    \"market\": \"futures\",\n    \"weekendHoldingAllowed\": false\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "Trading rule created successfully",
  "data": {
    "id": "660e8400-e29b-41d4-a716-446655440000",
    "name": "MFFU-style 50K Rules",
    "profitTarget": 3000,
    "maxLoss": 2500,
    "maxDrawdown": 0,
    "drawdownType": "static",
    "consistency": 50,
    "consistencyEnforced": true,
    "consistencyBase": null,
    "consistencyTolerancePct": 0.2,
    "consistencyLeniency": 0,
    "consistencyMinDays": null,
    "consistencyProfitableDayMin": 0,
    "maxPayouts": null,
    "payoutMllLockOffset": 100,
    "metadata": {
      "tier": "advanced",
      "market": "futures"
    },
    "createdAt": "2026-02-18T21:19:56.853Z"
  }
}

{
  "success": false,
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Invalid request data",
  "code": "BAD_REQUEST"
}

{
  "success": false,
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Authentication required",
  "code": "UNAUTHORIZED"
}

{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Admin access required",
  "code": "ADMIN_REQUIRED"
}

{
  "statusCode": 409,
  "error": "Conflict",
  "message": "A trading rule with this name already exists",
  "code": "RULE_NAME_EXISTS"
}

{
  "success": false,
  "statusCode": 500,
  "error": "Internal Server Error",
  "message": "An unexpected error occurred",
  "code": "INTERNAL_ERROR"
}

Platform API

Trade API

Market Data API

Create a new trading rule

Authorizations

Body

Response