Organization

Update a trading rule

Update an existing trading rule. Admin only.

Only provide fields you want to change. Use null to clear optional numeric fields.

Example - Update limits:

curl -X PATCH "https://api.example.com/platform/v1/organization/trading-rules/{ruleId}" \
  -H "X-API-Key: hp_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"maxLoss": 6000, "dailyLoss": 3000}'

Example - Clear a field:

curl -X PATCH ".../{ruleId}" \
  -d '{"consistency": null}'

Example - Set a contract scaling plan:

curl -X PATCH ".../{ruleId}" \
  -d '{"scalingPlan": {"basis": "balance", "tiers": [{"profit": 0, "maxContracts": 1}, {"profit": 1000, "maxContracts": 2}, {"profit": 3000, "maxContracts": 5.5}]}}'

Example - Change the micro conversion ratio (5 micros = 1 mini):

curl -X PATCH ".../{ruleId}" \
  -d '{"microConversionRatio": 5}'

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:

{ "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:

{
  "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:

{
  "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:

{
  "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:

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.

Warning: Changing rules affects how accounts using these rules are evaluated. Changes apply to future evaluations, not retroactively.

Error Codes:

Code	Description
`RULE_NOT_FOUND`	No rule exists with this ID
`RULE_NOT_IN_ORG`	Rule belongs to a different organization
`RULE_NAME_EXISTS`	Another rule already has this name
`NO_FIELDS_TO_UPDATE`	No valid fields provided
`ADMIN_REQUIRED`	Only admins can update rules

PATCH

organization

trading-rules

{ruleId}

Update a trading rule

curl --request PATCH \
  --url https://api.hyperprop.com/platform/v1/organization/trading-rules/{ruleId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Updated Rule Name",
  "description": "Updated description",
  "profitTarget": 12000,
  "dailyProfit": 123,
  "maxProfit": 123,
  "dailyLoss": 3000,
  "maxLoss": 6000,
  "dailyDrawdown": 123,
  "maxDrawdown": 123,
  "drawdownDenomination": "percent",
  "drawdownTrailCeiling": 100,
  "newsTradingAllowed": true,
  "microscalpingAllowed": true,
  "weekendHoldingAllowed": true,
  "overnightHoldingAllowed": true,
  "consistency": 123,
  "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": 123,
  "microConversionRatio": 5,
  "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": {
    "version": "2.0"
  },
  "mergeMetadata": true
}
'

import requests

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

payload = {
    "name": "Updated Rule Name",
    "description": "Updated description",
    "profitTarget": 12000,
    "dailyProfit": 123,
    "maxProfit": 123,
    "dailyLoss": 3000,
    "maxLoss": 6000,
    "dailyDrawdown": 123,
    "maxDrawdown": 123,
    "drawdownDenomination": "percent",
    "drawdownTrailCeiling": 100,
    "newsTradingAllowed": True,
    "microscalpingAllowed": True,
    "weekendHoldingAllowed": True,
    "overnightHoldingAllowed": True,
    "consistency": 123,
    "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": 123,
    "microConversionRatio": 5,
    "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": { "version": "2.0" },
    "mergeMetadata": True
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Updated Rule Name',
    description: 'Updated description',
    profitTarget: 12000,
    dailyProfit: 123,
    maxProfit: 123,
    dailyLoss: 3000,
    maxLoss: 6000,
    dailyDrawdown: 123,
    maxDrawdown: 123,
    drawdownDenomination: 'percent',
    drawdownTrailCeiling: 100,
    newsTradingAllowed: true,
    microscalpingAllowed: true,
    weekendHoldingAllowed: true,
    overnightHoldingAllowed: true,
    consistency: 123,
    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: 123,
    microConversionRatio: 5,
    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: {version: '2.0'},
    mergeMetadata: true
  })
};

fetch('https://api.hyperprop.com/platform/v1/organization/trading-rules/{ruleId}', 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/{ruleId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Updated Rule Name',
    'description' => 'Updated description',
    'profitTarget' => 12000,
    'dailyProfit' => 123,
    'maxProfit' => 123,
    'dailyLoss' => 3000,
    'maxLoss' => 6000,
    'dailyDrawdown' => 123,
    'maxDrawdown' => 123,
    'drawdownDenomination' => 'percent',
    'drawdownTrailCeiling' => 100,
    'newsTradingAllowed' => true,
    'microscalpingAllowed' => true,
    'weekendHoldingAllowed' => true,
    'overnightHoldingAllowed' => true,
    'consistency' => 123,
    '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' => 123,
    'microConversionRatio' => 5,
    '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' => [
        'version' => '2.0'
    ],
    'mergeMetadata' => true
  ]),
  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/{ruleId}"

	payload := strings.NewReader("{\n  \"name\": \"Updated Rule Name\",\n  \"description\": \"Updated description\",\n  \"profitTarget\": 12000,\n  \"dailyProfit\": 123,\n  \"maxProfit\": 123,\n  \"dailyLoss\": 3000,\n  \"maxLoss\": 6000,\n  \"dailyDrawdown\": 123,\n  \"maxDrawdown\": 123,\n  \"drawdownDenomination\": \"percent\",\n  \"drawdownTrailCeiling\": 100,\n  \"newsTradingAllowed\": true,\n  \"microscalpingAllowed\": true,\n  \"weekendHoldingAllowed\": true,\n  \"overnightHoldingAllowed\": true,\n  \"consistency\": 123,\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\": 123,\n  \"microConversionRatio\": 5,\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    \"version\": \"2.0\"\n  },\n  \"mergeMetadata\": true\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.hyperprop.com/platform/v1/organization/trading-rules/{ruleId}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Updated Rule Name\",\n  \"description\": \"Updated description\",\n  \"profitTarget\": 12000,\n  \"dailyProfit\": 123,\n  \"maxProfit\": 123,\n  \"dailyLoss\": 3000,\n  \"maxLoss\": 6000,\n  \"dailyDrawdown\": 123,\n  \"maxDrawdown\": 123,\n  \"drawdownDenomination\": \"percent\",\n  \"drawdownTrailCeiling\": 100,\n  \"newsTradingAllowed\": true,\n  \"microscalpingAllowed\": true,\n  \"weekendHoldingAllowed\": true,\n  \"overnightHoldingAllowed\": true,\n  \"consistency\": 123,\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\": 123,\n  \"microConversionRatio\": 5,\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    \"version\": \"2.0\"\n  },\n  \"mergeMetadata\": true\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Updated Rule Name\",\n  \"description\": \"Updated description\",\n  \"profitTarget\": 12000,\n  \"dailyProfit\": 123,\n  \"maxProfit\": 123,\n  \"dailyLoss\": 3000,\n  \"maxLoss\": 6000,\n  \"dailyDrawdown\": 123,\n  \"maxDrawdown\": 123,\n  \"drawdownDenomination\": \"percent\",\n  \"drawdownTrailCeiling\": 100,\n  \"newsTradingAllowed\": true,\n  \"microscalpingAllowed\": true,\n  \"weekendHoldingAllowed\": true,\n  \"overnightHoldingAllowed\": true,\n  \"consistency\": 123,\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\": 123,\n  \"microConversionRatio\": 5,\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    \"version\": \"2.0\"\n  },\n  \"mergeMetadata\": true\n}"

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

{
  "success": true,
  "message": "Trading rule updated successfully",
  "data": {
    "id": "660e8400-e29b-41d4-a716-446655440000",
    "name": "Updated Rule Name",
    "profitTarget": 12000,
    "maxLoss": 6000,
    "consistency": 50,
    "consistencyEnforced": true,
    "consistencyBase": "<string>",
    "consistencyTolerancePct": 123,
    "consistencyLeniency": 123,
    "consistencyMinDays": 123,
    "consistencyProfitableDayMin": 123,
    "maxPayouts": 123,
    "payoutMllLockOffset": 123,
    "updatedAt": "2025-02-17T14:30:00.000Z"
  }
}

{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "No valid fields to update",
  "code": "NO_FIELDS_TO_UPDATE"
}

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

{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "This rule does not belong to your organization",
  "code": "RULE_NOT_IN_ORG"
}

{
  "statusCode": 404,
  "error": "Not Found",
  "message": "Trading rule not found",
  "code": "RULE_NOT_FOUND"
}

{
  "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.

Path Parameters

ruleId

string

required

The rule ID to update

Body

application/json

name

string

New rule name (must be unique)

Example:

"Updated Rule Name"

description

string

New description (null to clear)

Example:

"Updated description"

profitTarget

number

New profit target

Example:

12000

dailyProfit

number

New daily profit cap

maxProfit

number

New max profit cap

dailyLoss

number

New daily loss limit

Example:

3000

maxLoss

number

New max loss limit

Example:

6000

dailyDrawdown

number

New daily drawdown limit

maxDrawdown

number

New max drawdown limit

drawdownType

enum<string>

Change drawdown calculation method

Available options:

static,

trailing,

eod

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

New consistency requirement (% — see consistency notes)

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

New max contracts limit (mini-equivalent units). 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.

microConversionRatio

integer

How many micros count as 1 unit toward maxContracts (null resets to the default 10)

Required range: x >= 1

Example:

5

scalingPlan

object

New scaling plan (replaces existing; null to remove and fall back to maxContracts)

Show child attributes

Example:

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

personalRiskPolicy

object

Replaces the existing personal risk policy in full; null removes it and leaves traders unconstrained.

Show child attributes

Example:

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

metadata

object

New metadata. Replaces existing metadata wholesale unless mergeMetadata is true.

Example:

{ "version": "2.0" }

mergeMetadata

boolean

When true, the provided metadata keys are merged into the existing metadata instead of replacing it entirely

Example:

true

Response

Rule updated successfully

success

boolean

Example:

true

message

string

Example:

"Trading rule updated successfully"

data

object

Show child attributes

⌘I

Update a trading rule

curl --request PATCH \
  --url https://api.hyperprop.com/platform/v1/organization/trading-rules/{ruleId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Updated Rule Name",
  "description": "Updated description",
  "profitTarget": 12000,
  "dailyProfit": 123,
  "maxProfit": 123,
  "dailyLoss": 3000,
  "maxLoss": 6000,
  "dailyDrawdown": 123,
  "maxDrawdown": 123,
  "drawdownDenomination": "percent",
  "drawdownTrailCeiling": 100,
  "newsTradingAllowed": true,
  "microscalpingAllowed": true,
  "weekendHoldingAllowed": true,
  "overnightHoldingAllowed": true,
  "consistency": 123,
  "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": 123,
  "microConversionRatio": 5,
  "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": {
    "version": "2.0"
  },
  "mergeMetadata": true
}
'

import requests

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

payload = {
    "name": "Updated Rule Name",
    "description": "Updated description",
    "profitTarget": 12000,
    "dailyProfit": 123,
    "maxProfit": 123,
    "dailyLoss": 3000,
    "maxLoss": 6000,
    "dailyDrawdown": 123,
    "maxDrawdown": 123,
    "drawdownDenomination": "percent",
    "drawdownTrailCeiling": 100,
    "newsTradingAllowed": True,
    "microscalpingAllowed": True,
    "weekendHoldingAllowed": True,
    "overnightHoldingAllowed": True,
    "consistency": 123,
    "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": 123,
    "microConversionRatio": 5,
    "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": { "version": "2.0" },
    "mergeMetadata": True
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Updated Rule Name',
    description: 'Updated description',
    profitTarget: 12000,
    dailyProfit: 123,
    maxProfit: 123,
    dailyLoss: 3000,
    maxLoss: 6000,
    dailyDrawdown: 123,
    maxDrawdown: 123,
    drawdownDenomination: 'percent',
    drawdownTrailCeiling: 100,
    newsTradingAllowed: true,
    microscalpingAllowed: true,
    weekendHoldingAllowed: true,
    overnightHoldingAllowed: true,
    consistency: 123,
    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: 123,
    microConversionRatio: 5,
    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: {version: '2.0'},
    mergeMetadata: true
  })
};

fetch('https://api.hyperprop.com/platform/v1/organization/trading-rules/{ruleId}', 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/{ruleId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Updated Rule Name',
    'description' => 'Updated description',
    'profitTarget' => 12000,
    'dailyProfit' => 123,
    'maxProfit' => 123,
    'dailyLoss' => 3000,
    'maxLoss' => 6000,
    'dailyDrawdown' => 123,
    'maxDrawdown' => 123,
    'drawdownDenomination' => 'percent',
    'drawdownTrailCeiling' => 100,
    'newsTradingAllowed' => true,
    'microscalpingAllowed' => true,
    'weekendHoldingAllowed' => true,
    'overnightHoldingAllowed' => true,
    'consistency' => 123,
    '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' => 123,
    'microConversionRatio' => 5,
    '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' => [
        'version' => '2.0'
    ],
    'mergeMetadata' => true
  ]),
  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/{ruleId}"

	payload := strings.NewReader("{\n  \"name\": \"Updated Rule Name\",\n  \"description\": \"Updated description\",\n  \"profitTarget\": 12000,\n  \"dailyProfit\": 123,\n  \"maxProfit\": 123,\n  \"dailyLoss\": 3000,\n  \"maxLoss\": 6000,\n  \"dailyDrawdown\": 123,\n  \"maxDrawdown\": 123,\n  \"drawdownDenomination\": \"percent\",\n  \"drawdownTrailCeiling\": 100,\n  \"newsTradingAllowed\": true,\n  \"microscalpingAllowed\": true,\n  \"weekendHoldingAllowed\": true,\n  \"overnightHoldingAllowed\": true,\n  \"consistency\": 123,\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\": 123,\n  \"microConversionRatio\": 5,\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    \"version\": \"2.0\"\n  },\n  \"mergeMetadata\": true\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.hyperprop.com/platform/v1/organization/trading-rules/{ruleId}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Updated Rule Name\",\n  \"description\": \"Updated description\",\n  \"profitTarget\": 12000,\n  \"dailyProfit\": 123,\n  \"maxProfit\": 123,\n  \"dailyLoss\": 3000,\n  \"maxLoss\": 6000,\n  \"dailyDrawdown\": 123,\n  \"maxDrawdown\": 123,\n  \"drawdownDenomination\": \"percent\",\n  \"drawdownTrailCeiling\": 100,\n  \"newsTradingAllowed\": true,\n  \"microscalpingAllowed\": true,\n  \"weekendHoldingAllowed\": true,\n  \"overnightHoldingAllowed\": true,\n  \"consistency\": 123,\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\": 123,\n  \"microConversionRatio\": 5,\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    \"version\": \"2.0\"\n  },\n  \"mergeMetadata\": true\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Updated Rule Name\",\n  \"description\": \"Updated description\",\n  \"profitTarget\": 12000,\n  \"dailyProfit\": 123,\n  \"maxProfit\": 123,\n  \"dailyLoss\": 3000,\n  \"maxLoss\": 6000,\n  \"dailyDrawdown\": 123,\n  \"maxDrawdown\": 123,\n  \"drawdownDenomination\": \"percent\",\n  \"drawdownTrailCeiling\": 100,\n  \"newsTradingAllowed\": true,\n  \"microscalpingAllowed\": true,\n  \"weekendHoldingAllowed\": true,\n  \"overnightHoldingAllowed\": true,\n  \"consistency\": 123,\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\": 123,\n  \"microConversionRatio\": 5,\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    \"version\": \"2.0\"\n  },\n  \"mergeMetadata\": true\n}"

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

{
  "success": true,
  "message": "Trading rule updated successfully",
  "data": {
    "id": "660e8400-e29b-41d4-a716-446655440000",
    "name": "Updated Rule Name",
    "profitTarget": 12000,
    "maxLoss": 6000,
    "consistency": 50,
    "consistencyEnforced": true,
    "consistencyBase": "<string>",
    "consistencyTolerancePct": 123,
    "consistencyLeniency": 123,
    "consistencyMinDays": 123,
    "consistencyProfitableDayMin": 123,
    "maxPayouts": 123,
    "payoutMllLockOffset": 123,
    "updatedAt": "2025-02-17T14:30:00.000Z"
  }
}

{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "No valid fields to update",
  "code": "NO_FIELDS_TO_UPDATE"
}

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

{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "This rule does not belong to your organization",
  "code": "RULE_NOT_IN_ORG"
}

{
  "statusCode": 404,
  "error": "Not Found",
  "message": "Trading rule not found",
  "code": "RULE_NOT_FOUND"
}

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

Update a trading rule

Position limits: pick the right field

Authorizations

Path Parameters

Body

Response