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 |
| `dailyProfitEnforced` | bool | Engine enforces `dailyProfit`: the account is flattened and locked until the next trading day, without failing it. Off by default (informational) | false |
| `bestDayStopPct` | % | Best-day stop: once the day's P&L, open positions included, is above this percent of `profitTarget` (exactly on it is allowed), the account is flattened and locked until the next trading day, without failing it. When `dailyProfitEnforced` is also on, the lower of the two limits applies. Requires `profitTarget` > 0. 0 = off (default) | 40 |
| `maxProfit` | $ | Max total profit cap (0 = unlimited) | 0 |
| `dailyLoss` | $ | Max loss allowed per day | 1000 |
| `dailyLossOffThreshold` | $ | Daily loss limit switch-off: once an end-of-day balance (closed balance; open positions do not count) is at or above the starting balance plus this amount, `dailyLoss` is not enforced from the next trading day and you receive `account.daily_loss_limit_off`. Has no effect without `dailyLoss`; every other rule is unchanged. null = off (default) | 500 |
| `dailyLossOffMode` | | `while_above` (default): back on from the next trading day after an end-of-day balance below the target (`account.daily_loss_limit_on`). `permanent`: off until the account is reset | while_above |
| `dailyLossEntryBufferTicks` | ticks | Daily-loss entry buffer: a new entry is refused when the room left under `dailyLoss` does not cover its round-trip fees plus this many ticks per contract. Exits are never refused. 0 = off (default) | 4 |
| `maxLoss` | $ | Max total loss from starting balance | 2500 |
| `dailyDrawdown` | % | Max daily loss as a whole-number percent of the day's starting balance, open P&L included (2 = 2%) | 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 |
| `maxPositionByProduct` | count per root | Per-product position cap in that product's own contracts, per side (open positions plus working entry orders); exits always allowed; applies on top of maxContracts, stricter wins; none by default | {"SIL": 5} |
| `blockedSymbols` | roots | Contract roots that cannot be opened on this rule set (e.g. a micros-only plan blocks ES, NQ, YM, RTY, CL, GC). Exits always allowed; empty = nothing blocked | ["ES", "NQ"] |
| `sessionWindowStart` / `sessionWindowEnd` | HH:MM | Trading session for this rule set, e.g. a New York session product. Outside it new positions are refused (`OUTSIDE_TRADING_SESSION`) while closing or reducing stays allowed; at the session end open positions are closed. Set both or neither; omit for no session (default) | "09:30" / "16:00" |
| `sessionWindowTimezone` | IANA zone | Time zone of the session times, daylight-saving aware (default America/New_York) | "America/New_York" |
| `maxAccountDays` | days | Hard time limit: an in-progress account that has not passed by the end of this many calendar days from activation fails with ruleType `time_limit_exceeded`. Activation is when the trader redeemed the import key, or account creation for accounts created for their trader; that day is day 1. The clock runs whether or not the account trades and resets do not restart it. Days roll at 17:00 CT. 0 = no time limit (default) | 30 |
| `maxInactiveDays` | days | Inactivity: the account fails with ruleType `inactivity` after this many consecutive calendar days without a fill (counted from the last fill, or from the start if there is none; an open position counts as activity). 0 = off (default) | 10 |
| `timeLimitExtensionDays` | days | One-time extension of `maxAccountDays`: an in-progress account that reaches the end of its time limit with total profit (open positions included) strictly above `timeLimitExtensionMinProgressPct` % of `profitTarget` gets this many more days instead of failing, and you receive `account.time_limit_extended`. Decided once per account; after the extended deadline the account fails with ruleType `time_limit_exceeded`. 0 = off (default) | 30 |
| `timeLimitExtensionMinProgressPct` | % | Progress needed for the extension, 0-100 % of `profitTarget`, strictly above (with a $3,000 target and 50, $1,500.01 qualifies, $1,500 does not). Default 0 | 50 |
| `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).
**Trading session (`sessionWindowStart`, `sessionWindowEnd`, `sessionWindowTimezone`):**
Restricts accounts on this rule set to a daily trading session, so one organization can sell a full-session product and, say, a New York session product (09:30–16:00 America/New_York) side by side. Off by default: with no session set, trading follows the market hours and your organization's session settings exactly as before.
- Outside the session, new positions are refused with error code `OUTSIDE_TRADING_SESSION`. Closing or reducing a position, cancelling orders and take-profit / stop-loss exits are always allowed.
- At the session end, open positions are closed and working orders are cancelled.
- The session is evaluated every day in its own time zone and follows daylight saving time. An end earlier than the start is an overnight session (e.g. 18:00 → 02:00).
- It only narrows trading: the market's hours and your organization's session open delay and close buffer still apply, so trading is allowed only where they overlap.
- Set `sessionWindowStart` and `sessionWindowEnd` together (24-hour HH:MM); send both as `null` to remove the session. The time zone defaults to America/New_York.
**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 — a consistency-enforced 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.hyperprop.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 |
**Access:** full-access API keys only (a read-only key gets `403 READ_ONLY_KEY`). Dashboard members need manage access to Plans & rules.
{
"success": false,
"statusCode": 400,
"error": "Bad Request",
"message": "Invalid request data, including a field over its length limit (`VALIDATION_ERROR`), or metadata over the size limits (`METADATA_TOO_LARGE`)",
"code": "VALIDATION_ERROR"
}
{
"success": false,
"statusCode": 503,
"error": "Service Unavailable",
"message": "The Idempotency-Key could not be recorded, so the request was not run. Retry with the same key.",
"code": "IDEMPOTENCY_UNAVAILABLE"
}
Authorizations
X-API-Key
string
header
required
Organization API key (hp_live_...), sent in the X-API-Key header. Create, rotate and restrict keys in the dashboard or with the API keys endpoints; an organization can have two active keys, so you can rotate without downtime. A full-access key can call every endpoint in this reference. A read-only key can call GET endpoints (and create a trading stream token); any other request returns 403 READ_ONLY_KEY. A key with an IP allowlist returns 403 IP_NOT_ALLOWED from any other address. Each endpoint lists which keys can call it under Access.
Headers
Idempotency-Key
string
Optional. A value that identifies this operation on your side, at most 255 characters. A retry with the same key, method, path and body within 24 hours returns the original response (with Idempotency-Replayed: true) instead of repeating the change. The same key with a different body returns 409 IDEMPOTENCY_KEY_REUSED; a retry while the first request is still running returns 409 IDEMPOTENCY_KEY_IN_PROGRESS. A response that contains a credential (such as a new API key or signing secret) is not saved: the change is still not repeated, and a retry returns 409 IDEMPOTENCY_KEY_COMPLETED with the original status in originalStatus. Server errors (5xx) are not saved, so a retry runs again. If the key cannot be recorded, the request is not run and returns 503 IDEMPOTENCY_UNAVAILABLE; retry with the same key.
Maximum string length: 255
Body
application/json
name
string
required
Rule name (must be unique within your organization)
Maximum string length: 200
Example:
"Aggressive 100K Challenge"
description
string
Rule description
Maximum string length: 2000
Example:
"High risk tolerance rules for experienced traders"
profitTarget
integer
Profit target to pass ($)
Required range: 0 <= x <= 100000000
Example:
10000
dailyProfit
integer
Max daily profit cap (0 = unlimited)
Required range: 0 <= x <= 100000000
Example:
0
dailyProfitEnforced
boolean
Engine enforces dailyProfit: on reaching it the account is flattened and locked until the next trading day (default false, informational only)
Example:
false
bestDayStopPct
integer
Best-day stop: once the day's P&L, open positions included, is above this percent of profitTarget, the account is flattened and locked until the next trading day, without failing it. Landing exactly on it is allowed (40 with a $3,000 target: $1,200 is fine, $1,200.01 stops). Checked continuously. Requires profitTarget > 0. 0 = off (default)
Required range: 0 <= x <= 100
Example:
0
maxProfit
integer
Max total profit cap (0 = unlimited)
Required range: 0 <= x <= 100000000
Example:
0
dailyLossEntryBufferTicks
integer
Daily-loss entry buffer: refuse a new entry when the room left under dailyLoss does not cover the order's round-trip fees plus this many ticks per contract, so the auto-close cannot land far past the limit straight after entry. Exits are never refused. Requires dailyLoss > 0. 0 = off (default): entries are allowed until the limit is breached
Required range: 0 <= x <= 100
Example:
0
dailyLoss
integer
Max loss allowed per day ($)
Required range: 0 <= x <= 100000000
Example:
2500
maxLoss
integer
Max total loss from starting balance ($)
Required range: 0 <= x <= 100000000
Example:
5000
dailyDrawdown
integer
Max daily loss as a whole-number percent of the day's starting balance (2 = 2%), open P&L included. 0 = off
Required range: 0 <= x <= 100
Example:
2
maxDrawdown
integer
Max drawdown from the reference. Percent of the reference by default (must be <= 100); a fixed dollar amount when drawdownDenomination is "dollars".
Required range: 0 <= x <= 100000000
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.
Required range: 0 <= x <= 100000000
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
integer
Consistency rule % — max share of profit any single day may reach (0 = disabled). See the consistency notes for the full formula and companion fields.
Required range: 0 <= x <= 100
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
maxAccountDays
integer
Hard time limit in calendar days, counted from activation: when the trader redeemed the account's import key, or when the account was created if it was created for the trader (that day is day 1). The clock runs whether or not the account trades, and resets do not restart it. An in-progress account that has not passed by the end of the last day fails with ruleType time_limit_exceeded. 0 or null = no time limit (default).
Required range: 0 <= x <= 3650
Example:
30
timeLimitExtensionDays
integer
One-time extension of maxAccountDays. When an in-progress account reaches the end of its time limit with total profit (open positions included) strictly above timeLimitExtensionMinProgressPct % of profitTarget, it gets this many more calendar days instead of failing, and you receive account.time_limit_extended. Decided once per account, at the end of the time limit; an account that later falls back below the threshold keeps its extension. Has no effect without maxAccountDays and profitTarget. 0 or null = off (default).
Required range: 0 <= x <= 3650
Example:
30
timeLimitExtensionMinProgressPct
integer
Progress required for the time-limit extension, as a whole percent (0-100) of profitTarget. Total profit must be strictly above it: with a $3,000 target and 50, $1,500.01 qualifies and exactly $1,500 does not. 0 = any profit above $0. Default 0.
Required range: 0 <= x <= 100
Example:
50
maxInactiveDays
integer
Consecutive calendar days without a fill after which the account fails with ruleType inactivity. Counted from the last fill, or from the start if the account has none. Holding an open position counts as activity. 0 or null = off (default).
Required range: 0 <= x <= 3650
Example:
10
dailyLossOffThreshold
integer
Switch the daily loss limit off once the account is this many dollars above its starting balance. Judged on the end-of-day balance (closed balance; open positions do not count; payouts and balance adjustments do) at each daily close: at or above starting balance + this amount, dailyLoss is not enforced from the next trading day, and you receive account.daily_loss_limit_off. Has no effect without dailyLoss. Every other rule, including dailyDrawdown, is unchanged. 0 or null = off (default).
Required range: 0 <= x <= 10000000
Example:
500
dailyLossOffMode
enum<string>
What happens after the daily loss limit is switched off. while_above (default): it is back on from the next trading day after an end-of-day balance below the target (account.daily_loss_limit_on). permanent: it stays off until the account is reset. null = while_above.
Available options:
while_above,
permanent
Example:
"while_above"
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 }
perpMaxLeverage
number
Perpetuals: the largest total open position value, as a multiple of the account balance (2 = positions worth up to twice the balance). Open positions and working orders count; closing orders never do. Capped at the instrument's own maximum. Null = no leverage cap (maxPositionByMarket still applies). Does not affect futures.
Required range: 1 <= x <= 1000
Example:
2
blockedSymbols
string[]
Contract roots that cannot be opened on accounts using this rule set. Use it for plans restricted to certain contracts, e.g. a micros-only plan lists the full-size contracts (ES, NQ, YM, RTY, CL, GC) and leaves MES, MNQ, MYM, M2K, MCL, MGC tradable. Roots are matched exactly, so ES never blocks MES. Only new positions are refused, with error code SYMBOL_BLOCKED_BY_PLAN; closing or reducing an existing position and take-profit / stop-loss exits are always allowed. Omit, send null or send [] to block nothing.
Maximum array length: 100
Pattern: ^[A-Z0-9]{1,12}$
Example:
["ES", "NQ", "YM", "RTY", "CL", "GC"]
sessionWindowStart
string
Start of the rule set's trading session (24-hour HH:MM, in sessionWindowTimezone). Send together with sessionWindowEnd; send both as null to remove the session. Outside the session new positions are refused with error code OUTSIDE_TRADING_SESSION; closing or reducing a position and take-profit / stop-loss exits are always allowed. At the session end open positions are closed and working orders cancelled. The market's own hours and your organization's session open delay and close buffer still apply, so trading is allowed only where they overlap.
Pattern: ^([01]\d|2[0-3]):[0-5]\d$
Example:
"09:30"
sessionWindowEnd
string
End of the trading session (24-hour HH:MM). An end earlier than the start is an overnight session, e.g. 18:00 → 02:00.
Pattern: ^([01]\d|2[0-3]):[0-5]\d$
Example:
"16:00"
sessionWindowTimezone
string
IANA time zone of the session times (default America/New_York). Session times follow daylight saving time in this zone.
Maximum string length: 64
Example:
"America/New_York"
maxPositionByProduct
object
Per-product position caps: contract root → the most contracts of that product an account may hold plus work on one side, e.g. {"SIL": 5} = at most 5 micro Silver long or 5 short. Counted in the product's own contracts across every contract month; open positions and working entry orders count, take-profit/stop-loss orders do not. Closing and reducing are always allowed, also on a position above a newly lowered cap. Applies on top of maxContracts / maxPositionByMarket (the stricter limit wins). Orders over the cap are rejected with PRODUCT_LIMIT_BY_PLAN. Roots are matched whole: a cap on SI does not cover SIL. null or {} removes every cap.
Example:
{ "SIL": 5 }
maxContracts
integer
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.
Required range: 0 <= x <= 1000000
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).
Custom metadata for your organization. At most 16 KB as JSON, 50 top-level keys and 5 levels of nesting; larger metadata returns 400 METADATA_TOO_LARGE.
{
"success": false,
"statusCode": 400,
"error": "Bad Request",
"message": "Invalid request data, including a field over its length limit (`VALIDATION_ERROR`), or metadata over the size limits (`METADATA_TOO_LARGE`)",
"code": "VALIDATION_ERROR"
}
{
"success": false,
"statusCode": 503,
"error": "Service Unavailable",
"message": "The Idempotency-Key could not be recorded, so the request was not run. Retry with the same key.",
"code": "IDEMPOTENCY_UNAVAILABLE"
}
{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"Hyperprop Platform API","colors":{"primary":"#253CFF","light":"#253CFF","dark":"#253CFF"},"logo":{"light":"https://mintcdn.com/hyperprop-401fc39d/snMIX7SYzcFqAv9j/logo/light.svg?fit=max\u0026auto=format\u0026n=snMIX7SYzcFqAv9j\u0026q=85\u0026s=e3a0a071fb4ba3ae53ef978c23cc38a3","dark":"https://mintcdn.com/hyperprop-401fc39d/snMIX7SYzcFqAv9j/logo/dark.svg?fit=max\u0026auto=format\u0026n=snMIX7SYzcFqAv9j\u0026q=85\u0026s=1e52fc25e71c2a6a9e047b4fbd60dae4","href":"https://hyperprop.com"},"favicon":"https://mintcdn.com/hyperprop-401fc39d/snMIX7SYzcFqAv9j/favicon.svg?fit=max\u0026auto=format\u0026n=snMIX7SYzcFqAv9j\u0026q=85\u0026s=760656e341413d4cd9dae53925c04cf6","navbar":{"primary":{"type":"button","label":"Open Dashboard","href":"https://portal.hyperprop.com"}},"footer":{"socials":{"x":"https://x.com/hyperpropcom","github":"https://github.com/Hyperprop-LLC-FZ"}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"hyperprop-401fc39d","hasAudioNarration":false,"actualSubdomain":"hyperprop-401fc39d","customDomains":["docs.hyperprop.com"],"gitSource":{"type":"github","owner":"hyperprop-llc-fz","repo":"hyperprop-mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af9d28c5400fbb020686d90","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"API Reference","count":246},{"language":"default","tag":"Platform API","count":202},{"language":"default","tag":"Trade API","count":44},{"language":"default","tag":"Risk","count":39},{"language":"default","tag":"Documentation","count":37},{"language":"default","tag":"Trading accounts","count":29},{"language":"default","tag":"Mass credit","count":23},{"language":"default","tag":"Billing and invoices","count":16},{"language":"default","tag":"Guides","count":14},{"language":"default","tag":"Webhooks","count":13}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#navbar nav-logo img,nav-logo img{height:2rem!important;width:auto}@media (max-width: 640px){pre{max-width:100%;overflow-x:auto}pre code{white-space:pre;word-break:normal}}@media (max-width: 640px){.prose table,#content-area table{display:block;max-width:100%;overflow-x:auto}}html.dark pre.shiki.shiki-themes,html[data-theme=\"dark\"] pre.shiki.shiki-themes{background-color:var(--shiki-dark-bg)!important;color:var(--shiki-dark)!important}html.dark pre.shiki.shiki-themes span,html[data-theme=\"dark\"] pre.shiki.shiki-themes span{color:var(--shiki-dark)!important;font-style:var(--shiki-dark-font-style)!important;font-weight:var(--shiki-dark-font-weight)!important;text-decoration:var(--shiki-dark-text-decoration)!important}"}],"page":{"pagePath":"platform-api/trading-rules/create-a-new-trading-rule","slug":"/platform-api/trading-rules/create-a-new-trading-rule","pageMetadata":{"title":"Create a new trading rule","description":"Create a new trading rule for your organization. **Admin only**.\n\n**Required fields:**\n- `name` - Must be unique within your organization\n\n**Optional rule parameters:**\n| Field | Unit | Description | Example |\n|-------|------|-------------|---------|\n| `profitTarget` | $ | Profit target to pass | 4000 |\n| `dailyProfit` | $ | Max daily profit cap (0 = unlimited) | 0 |\n| `dailyProfitEnforced` | bool | Engine enforces `dailyProfit`: the account is flattened and locked until the next trading day, without failing it. Off by default (informational) | false |\n| `bestDayStopPct` | % | Best-day stop: once the day's P\u0026L, open positions included, is above this percent of `profitTarget` (exactly on it is allowed), the account is flattened and locked until the next trading day, without failing it. When `dailyProfitEnforced` is also on, the lower of the two limits applies. Requires `profitTarget` > 0. 0 = off (default) | 40 |\n| `maxProfit` | $ | Max total profit cap (0 = unlimited) | 0 |\n| `dailyLoss` | $ | Max loss allowed per day | 1000 |\n| `dailyLossOffThreshold` | $ | Daily loss limit switch-off: once an end-of-day balance (closed balance; open positions do not count) is at or above the starting balance plus this amount, `dailyLoss` is not enforced from the next trading day and you receive `account.daily_loss_limit_off`. Has no effect without `dailyLoss`; every other rule is unchanged. null = off (default) | 500 |\n| `dailyLossOffMode` | | `while_above` (default): back on from the next trading day after an end-of-day balance below the target (`account.daily_loss_limit_on`). `permanent`: off until the account is reset | while_above |\n| `dailyLossEntryBufferTicks` | ticks | Daily-loss entry buffer: a new entry is refused when the room left under `dailyLoss` does not cover its round-trip fees plus this many ticks per contract. Exits are never refused. 0 = off (default) | 4 |\n| `maxLoss` | $ | Max total loss from starting balance | 2500 |\n| `dailyDrawdown` | % | Max daily loss as a whole-number percent of the day's starting balance, open P\u0026L included (2 = 2%) | 2 |\n| `maxDrawdown` | % or $ | Max drawdown (unit set by `drawdownDenomination`, reference by `drawdownType`) | 5 |\n| `drawdownDenomination` | | percent (default) or dollars — dollars is required for zero-based accounts | percent |\n| `drawdownTrailCeiling` | $ | Trailing floor lock level above initial balance (null = trails forever) | 100 |\n| `newsTradingAllowed` etc. | bool | Display-only permission flags (news trading, microscalping, weekend/overnight holding) shown to traders; default true, not engine-enforced | true |\n| `drawdownType` | | How drawdown is calculated (see below) | trailing |\n| `consistency` | % | Consistency rule (0 = disabled) | 0 |\n| `maxContracts` | count | Max position size in mini-equivalent contracts | 10 |\n| `microConversionRatio` | count | Micros per 1 unit toward maxContracts (default 10, see below) | 5 |\n| `maxPositionByProduct` | count per root | Per-product position cap in that product's own contracts, per side (open positions plus working entry orders); exits always allowed; applies on top of maxContracts, stricter wins; none by default | {\"SIL\": 5} |\n| `blockedSymbols` | roots | Contract roots that cannot be opened on this rule set (e.g. a micros-only plan blocks ES, NQ, YM, RTY, CL, GC). Exits always allowed; empty = nothing blocked | [\"ES\", \"NQ\"] |\n| `sessionWindowStart` / `sessionWindowEnd` | HH:MM | Trading session for this rule set, e.g. a New York session product. Outside it new positions are refused (`OUTSIDE_TRADING_SESSION`) while closing or reducing stays allowed; at the session end open positions are closed. Set both or neither; omit for no session (default) | \"09:30\" / \"16:00\" |\n| `sessionWindowTimezone` | IANA zone | Time zone of the session times, daylight-saving aware (default America/New_York) | \"America/New_York\" |\n| `maxAccountDays` | days | Hard time limit: an in-progress account that has not passed by the end of this many calendar days from activation fails with ruleType `time_limit_exceeded`. Activation is when the trader redeemed the import key, or account creation for accounts created for their trader; that day is day 1. The clock runs whether or not the account trades and resets do not restart it. Days roll at 17:00 CT. 0 = no time limit (default) | 30 |\n| `maxInactiveDays` | days | Inactivity: the account fails with ruleType `inactivity` after this many consecutive calendar days without a fill (counted from the last fill, or from the start if there is none; an open position counts as activity). 0 = off (default) | 10 |\n| `timeLimitExtensionDays` | days | One-time extension of `maxAccountDays`: an in-progress account that reaches the end of its time limit with total profit (open positions included) strictly above `timeLimitExtensionMinProgressPct` % of `profitTarget` gets this many more days instead of failing, and you receive `account.time_limit_extended`. Decided once per account; after the extended deadline the account fails with ruleType `time_limit_exceeded`. 0 = off (default) | 30 |\n| `timeLimitExtensionMinProgressPct` | % | Progress needed for the extension, 0-100 % of `profitTarget`, strictly above (with a $3,000 target and 50, $1,500.01 qualifies, $1,500 does not). Default 0 | 50 |\n| `scalingPlan` | | Profit-based contract scaling tiers (see below) | { \"tiers\": [...] } |\n| `metadata` | | Custom organization data | { \"version\": \"1.0\" } |\n\n**Understanding the units:**\n- **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.\n- **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).\n\n**Trading session (`sessionWindowStart`, `sessionWindowEnd`, `sessionWindowTimezone`):**\nRestricts accounts on this rule set to a daily trading session, so one organization can sell a full-session product and, say, a New York session product (09:30–16:00 America/New_York) side by side. Off by default: with no session set, trading follows the market hours and your organization's session settings exactly as before.\n- Outside the session, new positions are refused with error code `OUTSIDE_TRADING_SESSION`. Closing or reducing a position, cancelling orders and take-profit / stop-loss exits are always allowed.\n- At the session end, open positions are closed and working orders are cancelled.\n- The session is evaluated every day in its own time zone and follows daylight saving time. An end earlier than the start is an overnight session (e.g. 18:00 → 02:00).\n- It only narrows trading: the market's hours and your organization's session open delay and close buffer still apply, so trading is allowed only where they overlap.\n- Set `sessionWindowStart` and `sessionWindowEnd` together (24-hour HH:MM); send both as `null` to remove the session. The time zone defaults to America/New_York.\n\n**Drawdown types (`drawdownType`):**\n| Value | Description |\n|-------|-------------|\n| `static` | Drawdown measured from **initial balance**. Never moves. (default) |\n| `trailing` | Drawdown trails the **high water mark in real-time**. Updates on every fill. |\n| `eod` | Same as trailing but only updates at **end of day** (market close). Intraday highs don't move the floor. |\n\n**Micro contract conversion (`microConversionRatio`):**\n\n`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:\n\n| Ratio | `maxContracts: 10` allows |\n|-------|---------------------------|\n| `10` (default, CME notional ratio) | 10 minis or 100 micros, or any equivalent mix |\n| `5` | 10 minis or 50 micros |\n| `1` | 10 contracts total — micros count the same as minis |\n\nE-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.\n\nExample — a plan where 5 micros equal 1 mini:\n```json\n{ \"maxContracts\": 10, \"microConversionRatio\": 5 }\n```\n\n**Scaling plans (`scalingPlan`):**\n\n## Position limits: pick the right field\n\n`maxContracts` counts **engine units** and a rule is not tied to a market, so\none unit is one futures contract but **0.001 BTC** on the Binance perpetual. The\nsame number therefore means different things depending on which account the rule\nbacks. Use `maxPositionByMarket` for anything that is not plain futures:\n\n```json\n{\n \"name\": \"50K BTC Perp\",\n \"maxLoss\": 2000,\n \"dailyLoss\": 1000,\n \"maxPositionByMarket\": { \"BINANCE\": 0.5 }\n}\n```\n\nThat is **half a Bitcoin** — no conversion, no engine units. Rejections quote it\nback the same way:\n\n> Order would exceed the BINANCE position limit on this account: 0.600 BTC\n> requested, limit 0.500 BTC.\n\n| Field | Counts in | Scope | Use for |\n|---|---|---|---|\n| `maxPositionByMarket` | the market's own unit (BTC) | that market only | crypto, and any fractional contract |\n| `maxContracts` | mini-equivalents (micros via `microConversionRatio`) | all instruments | futures |\n\nA market named in `maxPositionByMarket` is **not** also gated by\n`maxContracts` — a market gets one limit or the other. Send `null` to clear\nevery per-market limit and put all markets back under `maxContracts`.\n\nInstead of a flat `maxContracts` limit, you can define profit-based tiers that grow the trader's position size as they make profit:\n\n```json\n{\n \"scalingPlan\": {\n \"basis\": \"balance\",\n \"tiers\": [\n { \"profit\": 0, \"maxContracts\": 1 },\n { \"profit\": 1000, \"maxContracts\": 2 },\n { \"profit\": 3000, \"maxContracts\": 5.5 }\n ]\n }\n}\n```\n\n- `profit` is in dollars relative to the account's starting balance. The first tier must be `0` — it defines the starting limit.\n- 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:\n\n```json\n{\n \"tiers\": [\n { \"balance\": 50000, \"maxContracts\": 1 },\n { \"balance\": 55000, \"maxContracts\": 2 },\n { \"balance\": 60000, \"maxContracts\": 5.5 }\n ]\n}\n```\n\n 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.\n- `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.\n- `basis` controls when tiers activate/deactivate:\n | Value | Behavior |\n |-------|----------|\n | `balance` | Measured against current balance — limits scale back down if the balance drops below a threshold (default) |\n | `high_water_mark` | Measured against the best balance reached — tiers unlock permanently |\n- When `scalingPlan` is set it **overrides** `maxContracts`. Remove it (`\"scalingPlan\": null` on PATCH) to fall back to the flat limit.\n- Enforced in real time at order placement by the trade engine.\n\n**Consistency rule (`consistency` + related fields):**\n\nCaps how much of a trader's profit may come from a single day. The daily cap is:\n\n```text\ndaily_cap = round(base × consistency%, 2)\n + starting_balance × consistencyTolerancePct%\n + consistencyLeniency\n```\n\nA day whose net PnL **reaches or exceeds** the cap fails the rule (the boundary is inclusive). The formula is selected automatically by account type:\n\n- **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.\n- **Sim-funded accounts** — the rule gates *payouts*: base is the profit in the current payout cycle (since the last payout with `consistencyReset`).\n\n**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.\n\nExample — a consistency-enforced template: `{ \"consistency\": 50, \"consistencyEnforced\": true, \"consistencyTolerancePct\": 0.2 }` on evaluation rules, and `{ \"consistency\": 50, \"consistencyEnforced\": true, \"consistencyLeniency\": 40 }` on Builder sim-funded rules.\n\n**Sim-funded accounts — limits are optional per rule set:**\n\nEvery 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:\n\n- **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.\n- **You enforce**: attach a permissive rule set (limits `0`) and run your own logic; we still execute trades and payouts.\n\n`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.\n\n\n**Example:**\n```bash\ncurl -X POST \"https://api.hyperprop.com/platform/v1/organization/trading-rules\" \\\n -H \"X-API-Key: hp_live_your_key_here\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"Aggressive 100K Challenge\",\n \"description\": \"High risk tolerance for experienced traders\",\n \"profitTarget\": 10000,\n \"maxLoss\": 5000,\n \"maxDrawdown\": 5000,\n \"dailyLoss\": 2500,\n \"maxContracts\": 15,\n \"microConversionRatio\": 5,\n \"metadata\": { \"tier\": \"advanced\", \"version\": \"1.0\" }\n }'\n```\n\n**Error Codes:**\n| Code | Description |\n|------|-------------|\n| `RULE_NAME_EXISTS` | A rule with this name already exists |\n| `ADMIN_REQUIRED` | Only admins can create rules |\n\n**Access:** full-access API keys only (a read-only key gets `403 READ_ONLY_KEY`). Dashboard members need manage access to Plans \u0026 rules.","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-rules","href":"/platform-api/trading-rules/create-a-new-trading-rule","autogeneratedByOpenApi":true},"description":"Create a new trading rule for your organization. **Admin only**.\n\n**Required fields:**\n- `name` - Must be unique within your organization\n\n**Optional rule parameters:**\n| Field | Unit | Description | Example |\n|-------|------|-------------|---------|\n| `profitTarget` | $ | Profit target to pass | 4000 |\n| `dailyProfit` | $ | Max daily profit cap (0 = unlimited) | 0 |\n| `dailyProfitEnforced` | bool | Engine enforces `dailyProfit`: the account is flattened and locked until the next trading day, without failing it. Off by default (informational) | false |\n| `bestDayStopPct` | % | Best-day stop: once the day's P\u0026L, open positions included, is above this percent of `profitTarget` (exactly on it is allowed), the account is flattened and locked until the next trading day, without failing it. When `dailyProfitEnforced` is also on, the lower of the two limits applies. Requires `profitTarget` > 0. 0 = off (default) | 40 |\n| `maxProfit` | $ | Max total profit cap (0 = unlimited) | 0 |\n| `dailyLoss` | $ | Max loss allowed per day | 1000 |\n| `dailyLossOffThreshold` | $ | Daily loss limit switch-off: once an end-of-day balance (closed balance; open positions do not count) is at or above the starting balance plus this amount, `dailyLoss` is not enforced from the next trading day and you receive `account.daily_loss_limit_off`. Has no effect without `dailyLoss`; every other rule is unchanged. null = off (default) | 500 |\n| `dailyLossOffMode` | | `while_above` (default): back on from the next trading day after an end-of-day balance below the target (`account.daily_loss_limit_on`). `permanent`: off until the account is reset | while_above |\n| `dailyLossEntryBufferTicks` | ticks | Daily-loss entry buffer: a new entry is refused when the room left under `dailyLoss` does not cover its round-trip fees plus this many ticks per contract. Exits are never refused. 0 = off (default) | 4 |\n| `maxLoss` | $ | Max total loss from starting balance | 2500 |\n| `dailyDrawdown` | % | Max daily loss as a whole-number percent of the day's starting balance, open P\u0026L included (2 = 2%) | 2 |\n| `maxDrawdown` | % or $ | Max drawdown (unit set by `drawdownDenomination`, reference by `drawdownType`) | 5 |\n| `drawdownDenomination` | | percent (default) or dollars — dollars is required for zero-based accounts | percent |\n| `drawdownTrailCeiling` | $ | Trailing floor lock level above initial balance (null = trails forever) | 100 |\n| `newsTradingAllowed` etc. | bool | Display-only permission flags (news trading, microscalping, weekend/overnight holding) shown to traders; default true, not engine-enforced | true |\n| `drawdownType` | | How drawdown is calculated (see below) | trailing |\n| `consistency` | % | Consistency rule (0 = disabled) | 0 |\n| `maxContracts` | count | Max position size in mini-equivalent contracts | 10 |\n| `microConversionRatio` | count | Micros per 1 unit toward maxContracts (default 10, see below) | 5 |\n| `maxPositionByProduct` | count per root | Per-product position cap in that product's own contracts, per side (open positions plus working entry orders); exits always allowed; applies on top of maxContracts, stricter wins; none by default | {\"SIL\": 5} |\n| `blockedSymbols` | roots | Contract roots that cannot be opened on this rule set (e.g. a micros-only plan blocks ES, NQ, YM, RTY, CL, GC). Exits always allowed; empty = nothing blocked | [\"ES\", \"NQ\"] |\n| `sessionWindowStart` / `sessionWindowEnd` | HH:MM | Trading session for this rule set, e.g. a New York session product. Outside it new positions are refused (`OUTSIDE_TRADING_SESSION`) while closing or reducing stays allowed; at the session end open positions are closed. Set both or neither; omit for no session (default) | \"09:30\" / \"16:00\" |\n| `sessionWindowTimezone` | IANA zone | Time zone of the session times, daylight-saving aware (default America/New_York) | \"America/New_York\" |\n| `maxAccountDays` | days | Hard time limit: an in-progress account that has not passed by the end of this many calendar days from activation fails with ruleType `time_limit_exceeded`. Activation is when the trader redeemed the import key, or account creation for accounts created for their trader; that day is day 1. The clock runs whether or not the account trades and resets do not restart it. Days roll at 17:00 CT. 0 = no time limit (default) | 30 |\n| `maxInactiveDays` | days | Inactivity: the account fails with ruleType `inactivity` after this many consecutive calendar days without a fill (counted from the last fill, or from the start if there is none; an open position counts as activity). 0 = off (default) | 10 |\n| `timeLimitExtensionDays` | days | One-time extension of `maxAccountDays`: an in-progress account that reaches the end of its time limit with total profit (open positions included) strictly above `timeLimitExtensionMinProgressPct` % of `profitTarget` gets this many more days instead of failing, and you receive `account.time_limit_extended`. Decided once per account; after the extended deadline the account fails with ruleType `time_limit_exceeded`. 0 = off (default) | 30 |\n| `timeLimitExtensionMinProgressPct` | % | Progress needed for the extension, 0-100 % of `profitTarget`, strictly above (with a $3,000 target and 50, $1,500.01 qualifies, $1,500 does not). Default 0 | 50 |\n| `scalingPlan` | | Profit-based contract scaling tiers (see below) | { \"tiers\": [...] } |\n| `metadata` | | Custom organization data | { \"version\": \"1.0\" } |\n\n**Understanding the units:**\n- **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.\n- **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).\n\n**Trading session (`sessionWindowStart`, `sessionWindowEnd`, `sessionWindowTimezone`):**\nRestricts accounts on this rule set to a daily trading session, so one organization can sell a full-session product and, say, a New York session product (09:30–16:00 America/New_York) side by side. Off by default: with no session set, trading follows the market hours and your organization's session settings exactly as before.\n- Outside the session, new positions are refused with error code `OUTSIDE_TRADING_SESSION`. Closing or reducing a position, cancelling orders and take-profit / stop-loss exits are always allowed.\n- At the session end, open positions are closed and working orders are cancelled.\n- The session is evaluated every day in its own time zone and follows daylight saving time. An end earlier than the start is an overnight session (e.g. 18:00 → 02:00).\n- It only narrows trading: the market's hours and your organization's session open delay and close buffer still apply, so trading is allowed only where they overlap.\n- Set `sessionWindowStart` and `sessionWindowEnd` together (24-hour HH:MM); send both as `null` to remove the session. The time zone defaults to America/New_York.\n\n**Drawdown types (`drawdownType`):**\n| Value | Description |\n|-------|-------------|\n| `static` | Drawdown measured from **initial balance**. Never moves. (default) |\n| `trailing` | Drawdown trails the **high water mark in real-time**. Updates on every fill. |\n| `eod` | Same as trailing but only updates at **end of day** (market close). Intraday highs don't move the floor. |\n\n**Micro contract conversion (`microConversionRatio`):**\n\n`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:\n\n| Ratio | `maxContracts: 10` allows |\n|-------|---------------------------|\n| `10` (default, CME notional ratio) | 10 minis or 100 micros, or any equivalent mix |\n| `5` | 10 minis or 50 micros |\n| `1` | 10 contracts total — micros count the same as minis |\n\nE-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.\n\nExample — a plan where 5 micros equal 1 mini:\n```json\n{ \"maxContracts\": 10, \"microConversionRatio\": 5 }\n```\n\n**Scaling plans (`scalingPlan`):**\n\n## Position limits: pick the right field\n\n`maxContracts` counts **engine units** and a rule is not tied to a market, so\none unit is one futures contract but **0.001 BTC** on the Binance perpetual. The\nsame number therefore means different things depending on which account the rule\nbacks. Use `maxPositionByMarket` for anything that is not plain futures:\n\n```json\n{\n \"name\": \"50K BTC Perp\",\n \"maxLoss\": 2000,\n \"dailyLoss\": 1000,\n \"maxPositionByMarket\": { \"BINANCE\": 0.5 }\n}\n```\n\nThat is **half a Bitcoin** — no conversion, no engine units. Rejections quote it\nback the same way:\n\n> Order would exceed the BINANCE position limit on this account: 0.600 BTC\n> requested, limit 0.500 BTC.\n\n| Field | Counts in | Scope | Use for |\n|---|---|---|---|\n| `maxPositionByMarket` | the market's own unit (BTC) | that market only | crypto, and any fractional contract |\n| `maxContracts` | mini-equivalents (micros via `microConversionRatio`) | all instruments | futures |\n\nA market named in `maxPositionByMarket` is **not** also gated by\n`maxContracts` — a market gets one limit or the other. Send `null` to clear\nevery per-market limit and put all markets back under `maxContracts`.\n\nInstead of a flat `maxContracts` limit, you can define profit-based tiers that grow the trader's position size as they make profit:\n\n```json\n{\n \"scalingPlan\": {\n \"basis\": \"balance\",\n \"tiers\": [\n { \"profit\": 0, \"maxContracts\": 1 },\n { \"profit\": 1000, \"maxContracts\": 2 },\n { \"profit\": 3000, \"maxContracts\": 5.5 }\n ]\n }\n}\n```\n\n- `profit` is in dollars relative to the account's starting balance. The first tier must be `0` — it defines the starting limit.\n- 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:\n\n```json\n{\n \"tiers\": [\n { \"balance\": 50000, \"maxContracts\": 1 },\n { \"balance\": 55000, \"maxContracts\": 2 },\n { \"balance\": 60000, \"maxContracts\": 5.5 }\n ]\n}\n```\n\n 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.\n- `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.\n- `basis` controls when tiers activate/deactivate:\n | Value | Behavior |\n |-------|----------|\n | `balance` | Measured against current balance — limits scale back down if the balance drops below a threshold (default) |\n | `high_water_mark` | Measured against the best balance reached — tiers unlock permanently |\n- When `scalingPlan` is set it **overrides** `maxContracts`. Remove it (`\"scalingPlan\": null` on PATCH) to fall back to the flat limit.\n- Enforced in real time at order placement by the trade engine.\n\n**Consistency rule (`consistency` + related fields):**\n\nCaps how much of a trader's profit may come from a single day. The daily cap is:\n\n```text\ndaily_cap = round(base × consistency%, 2)\n + starting_balance × consistencyTolerancePct%\n + consistencyLeniency\n```\n\nA day whose net PnL **reaches or exceeds** the cap fails the rule (the boundary is inclusive). The formula is selected automatically by account type:\n\n- **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.\n- **Sim-funded accounts** — the rule gates *payouts*: base is the profit in the current payout cycle (since the last payout with `consistencyReset`).\n\n**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.\n\nExample — a consistency-enforced template: `{ \"consistency\": 50, \"consistencyEnforced\": true, \"consistencyTolerancePct\": 0.2 }` on evaluation rules, and `{ \"consistency\": 50, \"consistencyEnforced\": true, \"consistencyLeniency\": 40 }` on Builder sim-funded rules.\n\n**Sim-funded accounts — limits are optional per rule set:**\n\nEvery 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:\n\n- **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.\n- **You enforce**: attach a permissive rule set (limits `0`) and run your own logic; we still execute trades and payouts.\n\n`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.\n\n\n**Example:**\n```bash\ncurl -X POST \"https://api.hyperprop.com/platform/v1/organization/trading-rules\" \\\n -H \"X-API-Key: hp_live_your_key_here\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"Aggressive 100K Challenge\",\n \"description\": \"High risk tolerance for experienced traders\",\n \"profitTarget\": 10000,\n \"maxLoss\": 5000,\n \"maxDrawdown\": 5000,\n \"dailyLoss\": 2500,\n \"maxContracts\": 15,\n \"microConversionRatio\": 5,\n \"metadata\": { \"tier\": \"advanced\", \"version\": \"1.0\" }\n }'\n```\n\n**Error Codes:**\n| Code | Description |\n|------|-------------|\n| `RULE_NAME_EXISTS` | A rule with this name already exists |\n| `ADMIN_REQUIRED` | Only admins can create rules |\n\n**Access:** full-access API keys only (a read-only key gets `403 READ_ONLY_KEY`). Dashboard members need manage access to Plans \u0026 rules.","pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create a new trading rule","description":"Create a new trading rule for your organization. **Admin only**.\n\n**Required fields:**\n- `name` - Must be unique within your organization\n\n**Optional rule parameters:**\n| Field | Unit | Description | Example |\n|-------|------|-------------|---------|\n| `profitTarget` | $ | Profit target to pass | 4000 |\n| `dailyProfit` | $ | Max daily profit cap (0 = unlimited) | 0 |\n| `dailyProfitEnforced` | bool | Engine enforces `dailyProfit`: the account is flattened and locked until the next trading day, without failing it. Off by default (informational) | false |\n| `bestDayStopPct` | % | Best-day stop: once the day's P\u0026L, open positions included, is above this percent of `profitTarget` (exactly on it is allowed), the account is flattened and locked until the next trading day, without failing it. When `dailyProfitEnforced` is also on, the lower of the two limits applies. Requires `profitTarget` > 0. 0 = off (default) | 40 |\n| `maxProfit` | $ | Max total profit cap (0 = unlimited) | 0 |\n| `dailyLoss` | $ | Max loss allowed per day | 1000 |\n| `dailyLossOffThreshold` | $ | Daily loss limit switch-off: once an end-of-day balance (closed balance; open positions do not count) is at or above the starting balance plus this amount, `dailyLoss` is not enforced from the next trading day and you receive `account.daily_loss_limit_off`. Has no effect without `dailyLoss`; every other rule is unchanged. null = off (default) | 500 |\n| `dailyLossOffMode` | | `while_above` (default): back on from the next trading day after an end-of-day balance below the target (`account.daily_loss_limit_on`). `permanent`: off until the account is reset | while_above |\n| `dailyLossEntryBufferTicks` | ticks | Daily-loss entry buffer: a new entry is refused when the room left under `dailyLoss` does not cover its round-trip fees plus this many ticks per contract. Exits are never refused. 0 = off (default) | 4 |\n| `maxLoss` | $ | Max total loss from starting balance | 2500 |\n| `dailyDrawdown` | % | Max daily loss as a whole-number percent of the day's starting balance, open P\u0026L included (2 = 2%) | 2 |\n| `maxDrawdown` | % or $ | Max drawdown (unit set by `drawdownDenomination`, reference by `drawdownType`) | 5 |\n| `drawdownDenomination` | | percent (default) or dollars — dollars is required for zero-based accounts | percent |\n| `drawdownTrailCeiling` | $ | Trailing floor lock level above initial balance (null = trails forever) | 100 |\n| `newsTradingAllowed` etc. | bool | Display-only permission flags (news trading, microscalping, weekend/overnight holding) shown to traders; default true, not engine-enforced | true |\n| `drawdownType` | | How drawdown is calculated (see below) | trailing |\n| `consistency` | % | Consistency rule (0 = disabled) | 0 |\n| `maxContracts` | count | Max position size in mini-equivalent contracts | 10 |\n| `microConversionRatio` | count | Micros per 1 unit toward maxContracts (default 10, see below) | 5 |\n| `maxPositionByProduct` | count per root | Per-product position cap in that product's own contracts, per side (open positions plus working entry orders); exits always allowed; applies on top of maxContracts, stricter wins; none by default | {\"SIL\": 5} |\n| `blockedSymbols` | roots | Contract roots that cannot be opened on this rule set (e.g. a micros-only plan blocks ES, NQ, YM, RTY, CL, GC). Exits always allowed; empty = nothing blocked | [\"ES\", \"NQ\"] |\n| `sessionWindowStart` / `sessionWindowEnd` | HH:MM | Trading session for this rule set, e.g. a New York session product. Outside it new positions are refused (`OUTSIDE_TRADING_SESSION`) while closing or reducing stays allowed; at the session end open positions are closed. Set both or neither; omit for no session (default) | \"09:30\" / \"16:00\" |\n| `sessionWindowTimezone` | IANA zone | Time zone of the session times, daylight-saving aware (default America/New_York) | \"America/New_York\" |\n| `maxAccountDays` | days | Hard time limit: an in-progress account that has not passed by the end of this many calendar days from activation fails with ruleType `time_limit_exceeded`. Activation is when the trader redeemed the import key, or account creation for accounts created for their trader; that day is day 1. The clock runs whether or not the account trades and resets do not restart it. Days roll at 17:00 CT. 0 = no time limit (default) | 30 |\n| `maxInactiveDays` | days | Inactivity: the account fails with ruleType `inactivity` after this many consecutive calendar days without a fill (counted from the last fill, or from the start if there is none; an open position counts as activity). 0 = off (default) | 10 |\n| `timeLimitExtensionDays` | days | One-time extension of `maxAccountDays`: an in-progress account that reaches the end of its time limit with total profit (open positions included) strictly above `timeLimitExtensionMinProgressPct` % of `profitTarget` gets this many more days instead of failing, and you receive `account.time_limit_extended`. Decided once per account; after the extended deadline the account fails with ruleType `time_limit_exceeded`. 0 = off (default) | 30 |\n| `timeLimitExtensionMinProgressPct` | % | Progress needed for the extension, 0-100 % of `profitTarget`, strictly above (with a $3,000 target and 50, $1,500.01 qualifies, $1,500 does not). Default 0 | 50 |\n| `scalingPlan` | | Profit-based contract scaling tiers (see below) | { \"tiers\": [...] } |\n| `metadata` | | Custom organization data | { \"version\": \"1.0\" } |\n\n**Understanding the units:**\n- **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.\n- **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).\n\n**Trading session (`sessionWindowStart`, `sessionWindowEnd`, `sessionWindowTimezone`):**\nRestricts accounts on this rule set to a daily trading session, so one organization can sell a full-session product and, say, a New York session product (09:30–16:00 America/New_York) side by side. Off by default: with no session set, trading follows the market hours and your organization's session settings exactly as before.\n- Outside the session, new positions are refused with error code `OUTSIDE_TRADING_SESSION`. Closing or reducing a position, cancelling orders and take-profit / stop-loss exits are always allowed.\n- At the session end, open positions are closed and working orders are cancelled.\n- The session is evaluated every day in its own time zone and follows daylight saving time. An end earlier than the start is an overnight session (e.g. 18:00 → 02:00).\n- It only narrows trading: the market's hours and your organization's session open delay and close buffer still apply, so trading is allowed only where they overlap.\n- Set `sessionWindowStart` and `sessionWindowEnd` together (24-hour HH:MM); send both as `null` to remove the session. The time zone defaults to America/New_York.\n\n**Drawdown types (`drawdownType`):**\n| Value | Description |\n|-------|-------------|\n| `static` | Drawdown measured from **initial balance**. Never moves. (default) |\n| `trailing` | Drawdown trails the **high water mark in real-time**. Updates on every fill. |\n| `eod` | Same as trailing but only updates at **end of day** (market close). Intraday highs don't move the floor. |\n\n**Micro contract conversion (`microConversionRatio`):**\n\n`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:\n\n| Ratio | `maxContracts: 10` allows |\n|-------|---------------------------|\n| `10` (default, CME notional ratio) | 10 minis or 100 micros, or any equivalent mix |\n| `5` | 10 minis or 50 micros |\n| `1` | 10 contracts total — micros count the same as minis |\n\nE-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.\n\nExample — a plan where 5 micros equal 1 mini:\n```json\n{ \"maxContracts\": 10, \"microConversionRatio\": 5 }\n```\n\n**Scaling plans (`scalingPlan`):**\n\n## Position limits: pick the right field\n\n`maxContracts` counts **engine units** and a rule is not tied to a market, so\none unit is one futures contract but **0.001 BTC** on the Binance perpetual. The\nsame number therefore means different things depending on which account the rule\nbacks. Use `maxPositionByMarket` for anything that is not plain futures:\n\n```json\n{\n \"name\": \"50K BTC Perp\",\n \"maxLoss\": 2000,\n \"dailyLoss\": 1000,\n \"maxPositionByMarket\": { \"BINANCE\": 0.5 }\n}\n```\n\nThat is **half a Bitcoin** — no conversion, no engine units. Rejections quote it\nback the same way:\n\n> Order would exceed the BINANCE position limit on this account: 0.600 BTC\n> requested, limit 0.500 BTC.\n\n| Field | Counts in | Scope | Use for |\n|---|---|---|---|\n| `maxPositionByMarket` | the market's own unit (BTC) | that market only | crypto, and any fractional contract |\n| `maxContracts` | mini-equivalents (micros via `microConversionRatio`) | all instruments | futures |\n\nA market named in `maxPositionByMarket` is **not** also gated by\n`maxContracts` — a market gets one limit or the other. Send `null` to clear\nevery per-market limit and put all markets back under `maxContracts`.\n\nInstead of a flat `maxContracts` limit, you can define profit-based tiers that grow the trader's position size as they make profit:\n\n```json\n{\n \"scalingPlan\": {\n \"basis\": \"balance\",\n \"tiers\": [\n { \"profit\": 0, \"maxContracts\": 1 },\n { \"profit\": 1000, \"maxContracts\": 2 },\n { \"profit\": 3000, \"maxContracts\": 5.5 }\n ]\n }\n}\n```\n\n- `profit` is in dollars relative to the account's starting balance. The first tier must be `0` — it defines the starting limit.\n- 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:\n\n```json\n{\n \"tiers\": [\n { \"balance\": 50000, \"maxContracts\": 1 },\n { \"balance\": 55000, \"maxContracts\": 2 },\n { \"balance\": 60000, \"maxContracts\": 5.5 }\n ]\n}\n```\n\n 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.\n- `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.\n- `basis` controls when tiers activate/deactivate:\n | Value | Behavior |\n |-------|----------|\n | `balance` | Measured against current balance — limits scale back down if the balance drops below a threshold (default) |\n | `high_water_mark` | Measured against the best balance reached — tiers unlock permanently |\n- When `scalingPlan` is set it **overrides** `maxContracts`. Remove it (`\"scalingPlan\": null` on PATCH) to fall back to the flat limit.\n- Enforced in real time at order placement by the trade engine.\n\n**Consistency rule (`consistency` + related fields):**\n\nCaps how much of a trader's profit may come from a single day. The daily cap is:\n\n```text\ndaily_cap = round(base × consistency%, 2)\n + starting_balance × consistencyTolerancePct%\n + consistencyLeniency\n```\n\nA day whose net PnL **reaches or exceeds** the cap fails the rule (the boundary is inclusive). The formula is selected automatically by account type:\n\n- **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.\n- **Sim-funded accounts** — the rule gates *payouts*: base is the profit in the current payout cycle (since the last payout with `consistencyReset`).\n\n**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.\n\nExample — a consistency-enforced template: `{ \"consistency\": 50, \"consistencyEnforced\": true, \"consistencyTolerancePct\": 0.2 }` on evaluation rules, and `{ \"consistency\": 50, \"consistencyEnforced\": true, \"consistencyLeniency\": 40 }` on Builder sim-funded rules.\n\n**Sim-funded accounts — limits are optional per rule set:**\n\nEvery 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:\n\n- **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.\n- **You enforce**: attach a permissive rule set (limits `0`) and run your own logic; we still execute trades and payouts.\n\n`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.\n\n\n**Example:**\n```bash\ncurl -X POST \"https://api.hyperprop.com/platform/v1/organization/trading-rules\" \\\n -H \"X-API-Key: hp_live_your_key_here\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"Aggressive 100K Challenge\",\n \"description\": \"High risk tolerance for experienced traders\",\n \"profitTarget\": 10000,\n \"maxLoss\": 5000,\n \"maxDrawdown\": 5000,\n \"dailyLoss\": 2500,\n \"maxContracts\": 15,\n \"microConversionRatio\": 5,\n \"metadata\": { \"tier\": \"advanced\", \"version\": \"1.0\" }\n }'\n```\n\n**Error Codes:**\n| Code | Description |\n|------|-------------|\n| `RULE_NAME_EXISTS` | A rule with this name already exists |\n| `ADMIN_REQUIRED` | Only admins can create rules |\n\n**Access:** full-access API keys only (a read-only key gets `403 READ_ONLY_KEY`). Dashboard members need manage access to Plans \u0026 rules.","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-rules","href":"/platform-api/trading-rules/create-a-new-trading-rule","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Create a new trading rule","operationId":"postV1OrganizationTradingrules","description":"Create a new trading rule for your organization. **Admin only**.\n\n**Required fields:**\n- `name` - Must be unique within your organization\n\n**Optional rule parameters:**\n| Field | Unit | Description | Example |\n|-------|------|-------------|---------|\n| `profitTarget` | $ | Profit target to pass | 4000 |\n| `dailyProfit` | $ | Max daily profit cap (0 = unlimited) | 0 |\n| `dailyProfitEnforced` | bool | Engine enforces `dailyProfit`: the account is flattened and locked until the next trading day, without failing it. Off by default (informational) | false |\n| `bestDayStopPct` | % | Best-day stop: once the day's P\u0026L, open positions included, is above this percent of `profitTarget` (exactly on it is allowed), the account is flattened and locked until the next trading day, without failing it. When `dailyProfitEnforced` is also on, the lower of the two limits applies. Requires `profitTarget` > 0. 0 = off (default) | 40 |\n| `maxProfit` | $ | Max total profit cap (0 = unlimited) | 0 |\n| `dailyLoss` | $ | Max loss allowed per day | 1000 |\n| `dailyLossOffThreshold` | $ | Daily loss limit switch-off: once an end-of-day balance (closed balance; open positions do not count) is at or above the starting balance plus this amount, `dailyLoss` is not enforced from the next trading day and you receive `account.daily_loss_limit_off`. Has no effect without `dailyLoss`; every other rule is unchanged. null = off (default) | 500 |\n| `dailyLossOffMode` | | `while_above` (default): back on from the next trading day after an end-of-day balance below the target (`account.daily_loss_limit_on`). `permanent`: off until the account is reset | while_above |\n| `dailyLossEntryBufferTicks` | ticks | Daily-loss entry buffer: a new entry is refused when the room left under `dailyLoss` does not cover its round-trip fees plus this many ticks per contract. Exits are never refused. 0 = off (default) | 4 |\n| `maxLoss` | $ | Max total loss from starting balance | 2500 |\n| `dailyDrawdown` | % | Max daily loss as a whole-number percent of the day's starting balance, open P\u0026L included (2 = 2%) | 2 |\n| `maxDrawdown` | % or $ | Max drawdown (unit set by `drawdownDenomination`, reference by `drawdownType`) | 5 |\n| `drawdownDenomination` | | percent (default) or dollars — dollars is required for zero-based accounts | percent |\n| `drawdownTrailCeiling` | $ | Trailing floor lock level above initial balance (null = trails forever) | 100 |\n| `newsTradingAllowed` etc. | bool | Display-only permission flags (news trading, microscalping, weekend/overnight holding) shown to traders; default true, not engine-enforced | true |\n| `drawdownType` | | How drawdown is calculated (see below) | trailing |\n| `consistency` | % | Consistency rule (0 = disabled) | 0 |\n| `maxContracts` | count | Max position size in mini-equivalent contracts | 10 |\n| `microConversionRatio` | count | Micros per 1 unit toward maxContracts (default 10, see below) | 5 |\n| `maxPositionByProduct` | count per root | Per-product position cap in that product's own contracts, per side (open positions plus working entry orders); exits always allowed; applies on top of maxContracts, stricter wins; none by default | {\"SIL\": 5} |\n| `blockedSymbols` | roots | Contract roots that cannot be opened on this rule set (e.g. a micros-only plan blocks ES, NQ, YM, RTY, CL, GC). Exits always allowed; empty = nothing blocked | [\"ES\", \"NQ\"] |\n| `sessionWindowStart` / `sessionWindowEnd` | HH:MM | Trading session for this rule set, e.g. a New York session product. Outside it new positions are refused (`OUTSIDE_TRADING_SESSION`) while closing or reducing stays allowed; at the session end open positions are closed. Set both or neither; omit for no session (default) | \"09:30\" / \"16:00\" |\n| `sessionWindowTimezone` | IANA zone | Time zone of the session times, daylight-saving aware (default America/New_York) | \"America/New_York\" |\n| `maxAccountDays` | days | Hard time limit: an in-progress account that has not passed by the end of this many calendar days from activation fails with ruleType `time_limit_exceeded`. Activation is when the trader redeemed the import key, or account creation for accounts created for their trader; that day is day 1. The clock runs whether or not the account trades and resets do not restart it. Days roll at 17:00 CT. 0 = no time limit (default) | 30 |\n| `maxInactiveDays` | days | Inactivity: the account fails with ruleType `inactivity` after this many consecutive calendar days without a fill (counted from the last fill, or from the start if there is none; an open position counts as activity). 0 = off (default) | 10 |\n| `timeLimitExtensionDays` | days | One-time extension of `maxAccountDays`: an in-progress account that reaches the end of its time limit with total profit (open positions included) strictly above `timeLimitExtensionMinProgressPct` % of `profitTarget` gets this many more days instead of failing, and you receive `account.time_limit_extended`. Decided once per account; after the extended deadline the account fails with ruleType `time_limit_exceeded`. 0 = off (default) | 30 |\n| `timeLimitExtensionMinProgressPct` | % | Progress needed for the extension, 0-100 % of `profitTarget`, strictly above (with a $3,000 target and 50, $1,500.01 qualifies, $1,500 does not). Default 0 | 50 |\n| `scalingPlan` | | Profit-based contract scaling tiers (see below) | { \"tiers\": [...] } |\n| `metadata` | | Custom organization data | { \"version\": \"1.0\" } |\n\n**Understanding the units:**\n- **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.\n- **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).\n\n**Trading session (`sessionWindowStart`, `sessionWindowEnd`, `sessionWindowTimezone`):**\nRestricts accounts on this rule set to a daily trading session, so one organization can sell a full-session product and, say, a New York session product (09:30–16:00 America/New_York) side by side. Off by default: with no session set, trading follows the market hours and your organization's session settings exactly as before.\n- Outside the session, new positions are refused with error code `OUTSIDE_TRADING_SESSION`. Closing or reducing a position, cancelling orders and take-profit / stop-loss exits are always allowed.\n- At the session end, open positions are closed and working orders are cancelled.\n- The session is evaluated every day in its own time zone and follows daylight saving time. An end earlier than the start is an overnight session (e.g. 18:00 → 02:00).\n- It only narrows trading: the market's hours and your organization's session open delay and close buffer still apply, so trading is allowed only where they overlap.\n- Set `sessionWindowStart` and `sessionWindowEnd` together (24-hour HH:MM); send both as `null` to remove the session. The time zone defaults to America/New_York.\n\n**Drawdown types (`drawdownType`):**\n| Value | Description |\n|-------|-------------|\n| `static` | Drawdown measured from **initial balance**. Never moves. (default) |\n| `trailing` | Drawdown trails the **high water mark in real-time**. Updates on every fill. |\n| `eod` | Same as trailing but only updates at **end of day** (market close). Intraday highs don't move the floor. |\n\n**Micro contract conversion (`microConversionRatio`):**\n\n`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:\n\n| Ratio | `maxContracts: 10` allows |\n|-------|---------------------------|\n| `10` (default, CME notional ratio) | 10 minis or 100 micros, or any equivalent mix |\n| `5` | 10 minis or 50 micros |\n| `1` | 10 contracts total — micros count the same as minis |\n\nE-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.\n\nExample — a plan where 5 micros equal 1 mini:\n```json\n{ \"maxContracts\": 10, \"microConversionRatio\": 5 }\n```\n\n**Scaling plans (`scalingPlan`):**\n\n## Position limits: pick the right field\n\n`maxContracts` counts **engine units** and a rule is not tied to a market, so\none unit is one futures contract but **0.001 BTC** on the Binance perpetual. The\nsame number therefore means different things depending on which account the rule\nbacks. Use `maxPositionByMarket` for anything that is not plain futures:\n\n```json\n{\n \"name\": \"50K BTC Perp\",\n \"maxLoss\": 2000,\n \"dailyLoss\": 1000,\n \"maxPositionByMarket\": { \"BINANCE\": 0.5 }\n}\n```\n\nThat is **half a Bitcoin** — no conversion, no engine units. Rejections quote it\nback the same way:\n\n> Order would exceed the BINANCE position limit on this account: 0.600 BTC\n> requested, limit 0.500 BTC.\n\n| Field | Counts in | Scope | Use for |\n|---|---|---|---|\n| `maxPositionByMarket` | the market's own unit (BTC) | that market only | crypto, and any fractional contract |\n| `maxContracts` | mini-equivalents (micros via `microConversionRatio`) | all instruments | futures |\n\nA market named in `maxPositionByMarket` is **not** also gated by\n`maxContracts` — a market gets one limit or the other. Send `null` to clear\nevery per-market limit and put all markets back under `maxContracts`.\n\nInstead of a flat `maxContracts` limit, you can define profit-based tiers that grow the trader's position size as they make profit:\n\n```json\n{\n \"scalingPlan\": {\n \"basis\": \"balance\",\n \"tiers\": [\n { \"profit\": 0, \"maxContracts\": 1 },\n { \"profit\": 1000, \"maxContracts\": 2 },\n { \"profit\": 3000, \"maxContracts\": 5.5 }\n ]\n }\n}\n```\n\n- `profit` is in dollars relative to the account's starting balance. The first tier must be `0` — it defines the starting limit.\n- 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:\n\n```json\n{\n \"tiers\": [\n { \"balance\": 50000, \"maxContracts\": 1 },\n { \"balance\": 55000, \"maxContracts\": 2 },\n { \"balance\": 60000, \"maxContracts\": 5.5 }\n ]\n}\n```\n\n 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.\n- `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.\n- `basis` controls when tiers activate/deactivate:\n | Value | Behavior |\n |-------|----------|\n | `balance` | Measured against current balance — limits scale back down if the balance drops below a threshold (default) |\n | `high_water_mark` | Measured against the best balance reached — tiers unlock permanently |\n- When `scalingPlan` is set it **overrides** `maxContracts`. Remove it (`\"scalingPlan\": null` on PATCH) to fall back to the flat limit.\n- Enforced in real time at order placement by the trade engine.\n\n**Consistency rule (`consistency` + related fields):**\n\nCaps how much of a trader's profit may come from a single day. The daily cap is:\n\n```text\ndaily_cap = round(base × consistency%, 2)\n + starting_balance × consistencyTolerancePct%\n + consistencyLeniency\n```\n\nA day whose net PnL **reaches or exceeds** the cap fails the rule (the boundary is inclusive). The formula is selected automatically by account type:\n\n- **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.\n- **Sim-funded accounts** — the rule gates *payouts*: base is the profit in the current payout cycle (since the last payout with `consistencyReset`).\n\n**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.\n\nExample — a consistency-enforced template: `{ \"consistency\": 50, \"consistencyEnforced\": true, \"consistencyTolerancePct\": 0.2 }` on evaluation rules, and `{ \"consistency\": 50, \"consistencyEnforced\": true, \"consistencyLeniency\": 40 }` on Builder sim-funded rules.\n\n**Sim-funded accounts — limits are optional per rule set:**\n\nEvery 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:\n\n- **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.\n- **You enforce**: attach a permissive rule set (limits `0`) and run your own logic; we still execute trades and payouts.\n\n`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.\n\n\n**Example:**\n```bash\ncurl -X POST \"https://api.hyperprop.com/platform/v1/organization/trading-rules\" \\\n -H \"X-API-Key: hp_live_your_key_here\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"Aggressive 100K Challenge\",\n \"description\": \"High risk tolerance for experienced traders\",\n \"profitTarget\": 10000,\n \"maxLoss\": 5000,\n \"maxDrawdown\": 5000,\n \"dailyLoss\": 2500,\n \"maxContracts\": 15,\n \"microConversionRatio\": 5,\n \"metadata\": { \"tier\": \"advanced\", \"version\": \"1.0\" }\n }'\n```\n\n**Error Codes:**\n| Code | Description |\n|------|-------------|\n| `RULE_NAME_EXISTS` | A rule with this name already exists |\n| `ADMIN_REQUIRED` | Only admins can create rules |\n\n**Access:** full-access API keys only (a read-only key gets `403 READ_ONLY_KEY`). Dashboard members need manage access to Plans \u0026 rules.","parameters":["20369334-518d-4f86-98a9-fb405cffc1fd"],"requestBody":"bf4a840f-4f8b-4842-9890-5662d43c3495","tags":["Trading rules"],"security":["e1744501-32c7-43c4-8413-6774ac3f96ab"],"responses":{"201":"1d41b699-b077-4122-9161-b99512c9da70","400":"1d3b2a45-6b26-4cb2-9980-a798cf2e5f73","401":"5cbfc758-6a7c-4b4d-8f28-dcce2a5f5a1e","403":"bbb2be05-744d-4274-9438-df00eb8dc294","409":"aec59ecc-951c-461b-aa05-d775e7ca804a","500":"008f8b7a-f5f1-4e7b-adcc-d8f49c533b64","503":"37dc468e-2539-4cfe-8437-3896ad5b0caf"},"method":"post","type":"path","servers":["b949171f-b56e-4c69-b8a6-d819dee3b071"],"path":"/v1/organization/trading-rules","baseUrlOptions":["https://api.hyperprop.com/platform"],"title":"Create a new trading rule","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"20369334-518d-4f86-98a9-fb405cffc1fd":{"name":"Idempotency-Key","in":"header","required":false,"description":"Optional. A value that identifies this operation on your side, at most 255 characters. A retry with the same key, method, path and body within 24 hours returns the original response (with `Idempotency-Replayed: true`) instead of repeating the change. The same key with a different body returns `409 IDEMPOTENCY_KEY_REUSED`; a retry while the first request is still running returns `409 IDEMPOTENCY_KEY_IN_PROGRESS`. A response that contains a credential (such as a new API key or signing secret) is not saved: the change is still not repeated, and a retry returns `409 IDEMPOTENCY_KEY_COMPLETED` with the original status in `originalStatus`. Server errors (5xx) are not saved, so a retry runs again. If the key cannot be recorded, the request is not run and returns `503 IDEMPOTENCY_UNAVAILABLE`; retry with the same key.","example":"crm-sync-8814-attempt-1","schema":{"type":"string","maxLength":255,"isRequired":false,"description":"Optional. A value that identifies this operation on your side, at most 255 characters. A retry with the same key, method, path and body within 24 hours returns the original response (with `Idempotency-Replayed: true`) instead of repeating the change. The same key with a different body returns `409 IDEMPOTENCY_KEY_REUSED`; a retry while the first request is still running returns `409 IDEMPOTENCY_KEY_IN_PROGRESS`. A response that contains a credential (such as a new API key or signing secret) is not saved: the change is still not repeated, and a retry returns `409 IDEMPOTENCY_KEY_COMPLETED` with the original status in `originalStatus`. Server errors (5xx) are not saved, so a retry runs again. If the key cannot be recorded, the request is not run and returns `503 IDEMPOTENCY_UNAVAILABLE`; retry with the same key.","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Rule name (must be unique within your organization)","example":"Aggressive 100K Challenge","maxLength":200,"isRequired":true,"uniqueKey":"name","typeLabel":"string"},"description":{"type":"string","description":"Rule description","example":"High risk tolerance rules for experienced traders","maxLength":2000,"uniqueKey":"description","typeLabel":"string"},"profitTarget":{"type":"integer","description":"Profit target to pass ($)","example":10000,"minimum":0,"maximum":100000000,"uniqueKey":"profitTarget","typeLabel":"integer"},"dailyProfit":{"type":"integer","description":"Max daily profit cap (0 = unlimited)","example":0,"minimum":0,"maximum":100000000,"uniqueKey":"dailyProfit","typeLabel":"integer"},"dailyProfitEnforced":{"type":"boolean","description":"Engine enforces dailyProfit: on reaching it the account is flattened and locked until the next trading day (default false, informational only)","example":false,"uniqueKey":"dailyProfitEnforced","typeLabel":"boolean"},"bestDayStopPct":{"type":"integer","description":"Best-day stop: once the day's P\u0026L, open positions included, is above this percent of profitTarget, the account is flattened and locked until the next trading day, without failing it. Landing exactly on it is allowed (40 with a $3,000 target: $1,200 is fine, $1,200.01 stops). Checked continuously. Requires profitTarget > 0. 0 = off (default)","example":0,"minimum":0,"maximum":100,"uniqueKey":"bestDayStopPct","typeLabel":"integer"},"maxProfit":{"type":"integer","description":"Max total profit cap (0 = unlimited)","example":0,"minimum":0,"maximum":100000000,"uniqueKey":"maxProfit","typeLabel":"integer"},"dailyLossEntryBufferTicks":{"type":"integer","description":"Daily-loss entry buffer: refuse a new entry when the room left under dailyLoss does not cover the order's round-trip fees plus this many ticks per contract, so the auto-close cannot land far past the limit straight after entry. Exits are never refused. Requires dailyLoss > 0. 0 = off (default): entries are allowed until the limit is breached","example":0,"minimum":0,"maximum":100,"uniqueKey":"dailyLossEntryBufferTicks","typeLabel":"integer"},"dailyLoss":{"type":"integer","description":"Max loss allowed per day ($)","example":2500,"minimum":0,"maximum":100000000,"uniqueKey":"dailyLoss","typeLabel":"integer"},"maxLoss":{"type":"integer","description":"Max total loss from starting balance ($)","example":5000,"minimum":0,"maximum":100000000,"uniqueKey":"maxLoss","typeLabel":"integer"},"dailyDrawdown":{"type":"integer","description":"Max daily loss as a whole-number percent of the day's starting balance (2 = 2%), open P\u0026L included. 0 = off","example":2,"minimum":0,"maximum":100,"uniqueKey":"dailyDrawdown","typeLabel":"integer"},"maxDrawdown":{"type":"integer","description":"Max drawdown from the reference. Percent of the reference by default (must be \u003c= 100); a fixed dollar amount when drawdownDenomination is \"dollars\".","example":5,"minimum":0,"maximum":100000000,"uniqueKey":"maxDrawdown","typeLabel":"integer"},"drawdownType":{"type":"string","description":"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.","example":"trailing","default":"static","enum":["static","trailing","eod"],"uniqueKey":"drawdownType","typeLabel":"enum\u003cstring>"},"drawdownDenomination":{"type":"string","description":"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.","example":"percent","enum":["percent","dollars"],"uniqueKey":"drawdownDenomination","typeLabel":"enum\u003cstring>"},"drawdownTrailCeiling":{"type":"number","description":"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,"minimum":0,"maximum":100000000,"x-constraint":{"precision":2},"uniqueKey":"drawdownTrailCeiling","typeLabel":"number"},"newsTradingAllowed":{"type":"boolean","description":"Display-only permission flag shown to traders: trading during news events (default true). Not engine-enforced.","example":true,"uniqueKey":"newsTradingAllowed","typeLabel":"boolean"},"microscalpingAllowed":{"type":"boolean","description":"Display-only permission flag shown to traders: microscalping (default true). Not engine-enforced.","example":true,"uniqueKey":"microscalpingAllowed","typeLabel":"boolean"},"weekendHoldingAllowed":{"type":"boolean","description":"Display-only permission flag shown to traders: holding positions over the weekend (default true). Not engine-enforced.","example":true,"uniqueKey":"weekendHoldingAllowed","typeLabel":"boolean"},"overnightHoldingAllowed":{"type":"boolean","description":"Display-only permission flag shown to traders: holding positions overnight (default true). Not engine-enforced.","example":true,"uniqueKey":"overnightHoldingAllowed","typeLabel":"boolean"},"consistency":{"type":"integer","description":"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,"minimum":0,"maximum":100,"uniqueKey":"consistency","typeLabel":"integer"},"consistencyEnforced":{"type":"boolean","description":"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,"uniqueKey":"consistencyEnforced","typeLabel":"boolean"},"consistencyBase":{"type":"string","description":"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.","example":"max_target_or_pnl","enum":["max_target_or_pnl","max_profit_target_or_pnl","total_pnl","profit_target","cycle_profit"],"uniqueKey":"consistencyBase","typeLabel":"enum\u003cstring>"},"consistencyTolerancePct":{"type":"number","description":"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.","example":0.2,"minimum":0,"uniqueKey":"consistencyTolerancePct","typeLabel":"number"},"consistencyLeniency":{"type":"number","description":"Flat dollar buffer added to the daily cap (e.g. 40 = $40 leniency on funded payout consistency).","example":40,"minimum":0,"uniqueKey":"consistencyLeniency","typeLabel":"number"},"consistencyMinDays":{"type":"integer","description":"Minimum profitable days required to pass an evaluation. null (default) = automatic ceil(100 / consistency), e.g. 50% → 2 days, 40% → 3 days. 0 = disabled.","example":2,"minimum":0,"uniqueKey":"consistencyMinDays","typeLabel":"integer"},"consistencyProfitableDayMin":{"type":"number","description":"A trading day counts as profitable when its net PnL is at least this many dollars. Default 0 (any non-negative traded day counts).","example":0,"minimum":0,"uniqueKey":"consistencyProfitableDayMin","typeLabel":"number"},"maxPayouts":{"type":"integer","description":"When set, the Nth processed payout fires the account.max_payouts_reached webhook (e.g. \"trader goes live after 5 payouts\"). null = unlimited.","example":5,"minimum":1,"uniqueKey":"maxPayouts","typeLabel":"integer"},"payoutMllLockOffset":{"type":"number","description":"Default loss-floor offset used by payouts requesting move_mll_to_lock: floor = initial balance + offset. Can be overridden per payout with lockBalance.","example":100,"minimum":0,"uniqueKey":"payoutMllLockOffset","typeLabel":"number"},"maxAccountDays":{"type":"integer","description":"Hard time limit in calendar days, counted from activation: when the trader redeemed the account's import key, or when the account was created if it was created for the trader (that day is day 1). The clock runs whether or not the account trades, and resets do not restart it. An in-progress account that has not passed by the end of the last day fails with ruleType time_limit_exceeded. 0 or null = no time limit (default).","example":30,"minimum":0,"maximum":3650,"uniqueKey":"maxAccountDays","typeLabel":"integer"},"timeLimitExtensionDays":{"type":"integer","description":"One-time extension of maxAccountDays. When an in-progress account reaches the end of its time limit with total profit (open positions included) strictly above timeLimitExtensionMinProgressPct % of profitTarget, it gets this many more calendar days instead of failing, and you receive account.time_limit_extended. Decided once per account, at the end of the time limit; an account that later falls back below the threshold keeps its extension. Has no effect without maxAccountDays and profitTarget. 0 or null = off (default).","example":30,"minimum":0,"maximum":3650,"uniqueKey":"timeLimitExtensionDays","typeLabel":"integer"},"timeLimitExtensionMinProgressPct":{"type":"integer","description":"Progress required for the time-limit extension, as a whole percent (0-100) of profitTarget. Total profit must be strictly above it: with a $3,000 target and 50, $1,500.01 qualifies and exactly $1,500 does not. 0 = any profit above $0. Default 0.","example":50,"minimum":0,"maximum":100,"uniqueKey":"timeLimitExtensionMinProgressPct","typeLabel":"integer"},"maxInactiveDays":{"type":"integer","description":"Consecutive calendar days without a fill after which the account fails with ruleType inactivity. Counted from the last fill, or from the start if the account has none. Holding an open position counts as activity. 0 or null = off (default).","example":10,"minimum":0,"maximum":3650,"uniqueKey":"maxInactiveDays","typeLabel":"integer"},"dailyLossOffThreshold":{"type":"integer","description":"Switch the daily loss limit off once the account is this many dollars above its starting balance. Judged on the end-of-day balance (closed balance; open positions do not count; payouts and balance adjustments do) at each daily close: at or above starting balance + this amount, dailyLoss is not enforced from the next trading day, and you receive account.daily_loss_limit_off. Has no effect without dailyLoss. Every other rule, including dailyDrawdown, is unchanged. 0 or null = off (default).","example":500,"minimum":0,"maximum":10000000,"uniqueKey":"dailyLossOffThreshold","typeLabel":"integer"},"dailyLossOffMode":{"type":"string","description":"What happens after the daily loss limit is switched off. while_above (default): it is back on from the next trading day after an end-of-day balance below the target (account.daily_loss_limit_on). permanent: it stays off until the account is reset. null = while_above.","example":"while_above","enum":["while_above","permanent"],"uniqueKey":"dailyLossOffMode","typeLabel":"enum\u003cstring>"},"maxPositionByMarket":{"type":"object","description":"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},"uniqueKey":"maxPositionByMarket","typeLabel":"object"},"perpMaxLeverage":{"type":"number","description":"Perpetuals: the largest total open position value, as a multiple of the account balance (2 = positions worth up to twice the balance). Open positions and working orders count; closing orders never do. Capped at the instrument's own maximum. Null = no leverage cap (maxPositionByMarket still applies). Does not affect futures.","example":2,"minimum":1,"maximum":1000,"uniqueKey":"perpMaxLeverage","typeLabel":"number"},"blockedSymbols":{"type":"array","description":"Contract roots that **cannot be opened** on accounts using this rule set. Use it for plans restricted to certain contracts, e.g. a micros-only plan lists the full-size contracts (`ES`, `NQ`, `YM`, `RTY`, `CL`, `GC`) and leaves `MES`, `MNQ`, `MYM`, `M2K`, `MCL`, `MGC` tradable. Roots are matched exactly, so `ES` never blocks `MES`. Only new positions are refused, with error code `SYMBOL_BLOCKED_BY_PLAN`; closing or reducing an existing position and take-profit / stop-loss exits are always allowed. Omit, send `null` or send `[]` to block nothing.","example":["ES","NQ","YM","RTY","CL","GC"],"maxItems":100,"items":{"type":"string","pattern":"^[A-Z0-9]{1,12}$","x-convert":{"case":"upper","trim":true},"uniqueKey":"blockedSymbols.items.[INDEX]","typeLabel":"string"},"uniqueKey":"blockedSymbols","typeLabel":"string[]"},"sessionWindowStart":{"type":"string","description":"Start of the rule set's trading session (24-hour HH:MM, in sessionWindowTimezone). Send together with sessionWindowEnd; send both as null to remove the session. Outside the session new positions are refused with error code `OUTSIDE_TRADING_SESSION`; closing or reducing a position and take-profit / stop-loss exits are always allowed. At the session end open positions are closed and working orders cancelled. The market's own hours and your organization's session open delay and close buffer still apply, so trading is allowed only where they overlap.","example":"09:30","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","x-convert":{"trim":true},"uniqueKey":"sessionWindowStart","typeLabel":"string"},"sessionWindowEnd":{"type":"string","description":"End of the trading session (24-hour HH:MM). An end earlier than the start is an overnight session, e.g. 18:00 → 02:00.","example":"16:00","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","x-convert":{"trim":true},"uniqueKey":"sessionWindowEnd","typeLabel":"string"},"sessionWindowTimezone":{"type":"string","description":"IANA time zone of the session times (default America/New_York). Session times follow daylight saving time in this zone.","example":"America/New_York","maxLength":64,"x-convert":{"trim":true},"uniqueKey":"sessionWindowTimezone","typeLabel":"string"},"maxPositionByProduct":{"type":"object","description":"Per-product position caps: contract root → the most contracts **of that product** an account may hold plus work on one side, e.g. `{\"SIL\": 5}` = at most 5 micro Silver long or 5 short. Counted in the product's own contracts across every contract month; open positions and working entry orders count, take-profit/stop-loss orders do not. Closing and reducing are always allowed, also on a position above a newly lowered cap. Applies on top of `maxContracts` / `maxPositionByMarket` (the stricter limit wins). Orders over the cap are rejected with `PRODUCT_LIMIT_BY_PLAN`. Roots are matched whole: a cap on `SI` does not cover `SIL`. `null` or `{}` removes every cap.","example":{"SIL":5},"uniqueKey":"maxPositionByProduct","typeLabel":"object"},"maxContracts":{"type":"integer","description":"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,"minimum":0,"maximum":1000000,"uniqueKey":"maxContracts","typeLabel":"integer"},"microConversionRatio":{"type":"integer","description":"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.","example":10,"minimum":1,"uniqueKey":"microConversionRatio","typeLabel":"integer"},"scalingPlan":{"type":"object","description":"Profit-based contract scaling tiers. Overrides maxContracts when set (see notes).","example":{"basis":"balance","tiers":[{"profit":0,"maxContracts":1},{"profit":1000,"maxContracts":2},{"profit":3000,"maxContracts":5.5}]},"properties":{"tiers":{"type":"array","description":"Tiers in ascending threshold order, all using the same key (all profit or all balance). The first tier defines the starting limit; in profit mode it must be 0.","minItems":1,"items":{"type":"object","properties":{"maxContracts":{"type":"number","description":"Max position size in mini-equivalent contracts once this tier is active. 0.1 steps allowed, e.g. 5.5 = 5 minis or 55 micros at the default 10:1 microConversionRatio. On a market whose contract steps fractionally (the BTCUSDT perpetual steps 0.001 BTC) this counts ENGINE units, so 100 is 0.1 BTC and 1000 is 1 BTC — read `quantityStep` on the contract rather than assuming one unit is one coin.","x-constraint":{"greater":0},"isRequired":true,"uniqueKey":"scalingPlan.tiers.items.[INDEX].maxContracts","typeLabel":"number"},"profit":{"type":"number","description":"Profit threshold in $ relative to starting balance (e.g. 1000). Each tier uses either profit or balance, not both.","minimum":0,"uniqueKey":"scalingPlan.tiers.items.[INDEX].profit","typeLabel":"number"},"balance":{"type":"number","description":"Absolute balance threshold in $ (e.g. 51000). Each tier uses either profit or balance, not both.","x-constraint":{"greater":0},"uniqueKey":"scalingPlan.tiers.items.[INDEX].balance","typeLabel":"number"}},"required":["maxContracts"],"uniqueKey":"scalingPlan.tiers.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"scalingPlan.tiers","typeLabel":"object[]"},"basis":{"type":"string","description":"What profit is measured against. \"balance\" = current balance (tiers scale back down after losses). \"high_water_mark\" = best balance reached (tiers unlock permanently).","default":"balance","enum":["balance","high_water_mark"],"uniqueKey":"scalingPlan.basis","typeLabel":"enum\u003cstring>"}},"required":["tiers"],"uniqueKey":"scalingPlan","typeLabel":"object"},"personalRiskPolicy":{"type":"object","description":"Bounds on the risk controls traders set for themselves on accounts using this rule set (see notes). Omit to leave traders unconstrained.","example":{"dailyLossLimitMax":1000,"dailyLossLimitDefault":500,"requireDailyLossLimit":true,"maxTradesPerDayMax":20},"properties":{"dailyLossLimitMax":{"type":"number","description":"Ceiling on a trader's personal daily loss limit, in dollars. If the trader sets none, this value (or dailyLossLimitDefault) becomes their limit.","example":1000,"x-constraint":{"sign":"positive"},"uniqueKey":"personalRiskPolicy.dailyLossLimitMax","typeLabel":"number"},"dailyLossLimitDefault":{"type":"number","description":"Seeded personal daily loss limit for traders who have not chosen one. Must not exceed dailyLossLimitMax.","example":500,"x-constraint":{"sign":"positive"},"uniqueKey":"personalRiskPolicy.dailyLossLimitDefault","typeLabel":"number"},"requireDailyLossLimit":{"type":"boolean","description":"Traders must have a personal daily loss limit, and it must be armed (an action other than do_nothing).","example":true,"uniqueKey":"personalRiskPolicy.requireDailyLossLimit","typeLabel":"boolean"},"maxTradesPerDayMax":{"type":"integer","description":"Ceiling on the trades-per-day limit a trader may set, at most 100,000. A trade is one position open. Omit it for no ceiling.","example":20,"maximum":100000,"x-constraint":{"sign":"positive"},"uniqueKey":"personalRiskPolicy.maxTradesPerDayMax","typeLabel":"integer"},"maxTradesPerWeekMax":{"type":"integer","description":"Ceiling on the trades-per-week limit a trader may set, at most 100,000. Omit it for no ceiling.","example":60,"maximum":100000,"x-constraint":{"sign":"positive"},"uniqueKey":"personalRiskPolicy.maxTradesPerWeekMax","typeLabel":"integer"},"requireAutoBracket":{"type":"boolean","description":"Traders cannot switch automatic TP/SL brackets off.","example":false,"uniqueKey":"personalRiskPolicy.requireAutoBracket","typeLabel":"boolean"},"lockedByFirm":{"type":"boolean","description":"Freeze personal risk settings entirely — traders can view but not change them.","example":false,"uniqueKey":"personalRiskPolicy.lockedByFirm","typeLabel":"boolean"}},"uniqueKey":"personalRiskPolicy","typeLabel":"object"},"metadata":{"type":"object","description":"Custom metadata for your organization. At most 16 KB as JSON, 50 top-level keys and 5 levels of nesting; larger metadata returns `400 METADATA_TOO_LARGE`.","example":{"ruleVersion":"1.0","market":"futures","weekendHoldingAllowed":false},"uniqueKey":"metadata","typeLabel":"object"}},"required":["name"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"Aggressive 100K Challenge","description":"High risk tolerance rules for experienced traders","profitTarget":10000,"dailyProfit":0,"dailyProfitEnforced":false,"bestDayStopPct":0,"maxProfit":0,"dailyLossEntryBufferTicks":0,"dailyLoss":2500,"maxLoss":5000,"dailyDrawdown":2,"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,"maxAccountDays":30,"timeLimitExtensionDays":30,"timeLimitExtensionMinProgressPct":50,"maxInactiveDays":10,"dailyLossOffThreshold":500,"dailyLossOffMode":"while_above","maxPositionByMarket":{"BINANCE":0.5},"perpMaxLeverage":2,"blockedSymbols":["ES","NQ","YM","RTY","CL","GC"],"sessionWindowStart":"09:30","sessionWindowEnd":"16:00","sessionWindowTimezone":"America/New_York","maxPositionByProduct":{"SIL":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}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"1d41b699-b077-4122-9161-b99512c9da70":{"description":"Rule created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","example":"Trading rule created successfully","uniqueKey":"message","typeLabel":"string"},"data":{"type":"object","example":{"id":"660e8400-e29b-41d4-a716-446655440000","name":"50K Evaluation 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"},"properties":{"id":{"type":"string","uniqueKey":"data.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"data.name","typeLabel":"string"},"profitTarget":{"type":"number","uniqueKey":"data.profitTarget","typeLabel":"number"},"maxLoss":{"type":"number","uniqueKey":"data.maxLoss","typeLabel":"number"},"maxDrawdown":{"type":"number","uniqueKey":"data.maxDrawdown","typeLabel":"number"},"consistency":{"type":"number","uniqueKey":"data.consistency","typeLabel":"number"},"consistencyEnforced":{"type":"boolean","description":"Whether the engine enforces the consistency rule for accounts on this rule set","uniqueKey":"data.consistencyEnforced","typeLabel":"boolean"},"consistencyBase":{"type":"string","description":"Configured base mode (null = automatic by account type)","uniqueKey":"data.consistencyBase","typeLabel":"string"},"consistencyTolerancePct":{"type":"number","description":"Daily-cap buffer as % of starting balance","uniqueKey":"data.consistencyTolerancePct","typeLabel":"number"},"consistencyLeniency":{"type":"number","description":"Flat $ daily-cap buffer","uniqueKey":"data.consistencyLeniency","typeLabel":"number"},"consistencyMinDays":{"type":"number","description":"Min profitable days (null = auto ceil(100/consistency))","uniqueKey":"data.consistencyMinDays","typeLabel":"number"},"consistencyProfitableDayMin":{"type":"number","description":"Min net PnL ($) for a day to count as profitable","uniqueKey":"data.consistencyProfitableDayMin","typeLabel":"number"},"maxPayouts":{"type":"number","description":"Payout count that triggers account.max_payouts_reached (null = unlimited)","uniqueKey":"data.maxPayouts","typeLabel":"number"},"payoutMllLockOffset":{"type":"number","description":"Default move_mll_to_lock offset ($ above initial balance)","uniqueKey":"data.payoutMllLockOffset","typeLabel":"number"},"maxAccountDays":{"type":"integer","description":"Calendar days to pass, counted from activation (0 = no time limit)","uniqueKey":"data.maxAccountDays","typeLabel":"integer"},"maxInactiveDays":{"type":"integer","description":"Consecutive calendar days without a fill before the account fails (0 = off)","uniqueKey":"data.maxInactiveDays","typeLabel":"integer"},"timeLimitExtensionDays":{"type":"integer","description":"One-time extension of maxAccountDays, in calendar days (0 = off)","uniqueKey":"data.timeLimitExtensionDays","typeLabel":"integer"},"timeLimitExtensionMinProgressPct":{"type":"integer","description":"Total profit must be strictly above this % of profitTarget for the extension","uniqueKey":"data.timeLimitExtensionMinProgressPct","typeLabel":"integer"},"dailyLossOffThreshold":{"type":"integer","description":"Dollars above the starting balance at which the daily loss limit switches off from the next trading day (null = off)","uniqueKey":"data.dailyLossOffThreshold","typeLabel":"integer"},"dailyLossOffMode":{"type":"string","description":"while_above (back on after a close below the target) or permanent","enum":["while_above","permanent"],"uniqueKey":"data.dailyLossOffMode","typeLabel":"enum\u003cstring>"},"metadata":{"type":"object","uniqueKey":"data.metadata","typeLabel":"object"},"createdAt":{"type":"string","uniqueKey":"data.createdAt","typeLabel":"string"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"message":"Trading rule created successfully","data":{"id":"660e8400-e29b-41d4-a716-446655440000","name":"50K Evaluation 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"}}}},"exampleType":"generated"}},"exampleType":"generated"},"1d3b2a45-6b26-4cb2-9980-a798cf2e5f73":{"description":"Invalid request data, including a field over its length limit (`VALIDATION_ERROR`), or metadata over the size limits (`METADATA_TOO_LARGE`)","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false on errors","example":false,"uniqueKey":"success","typeLabel":"boolean"},"statusCode":{"type":"number","example":400,"uniqueKey":"statusCode","typeLabel":"number"},"error":{"type":"string","example":"Bad Request","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","example":"Invalid request data, including a field over its length limit (`VALIDATION_ERROR`), or metadata over the size limits (`METADATA_TOO_LARGE`)","uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable error code — switch on this, not on message text","example":"VALIDATION_ERROR","uniqueKey":"code","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"statusCode":400,"error":"Bad Request","message":"Invalid request data, including a field over its length limit (`VALIDATION_ERROR`), or metadata over the size limits (`METADATA_TOO_LARGE`)","code":"VALIDATION_ERROR"}}},"exampleType":"generated"}},"exampleType":"generated"},"5cbfc758-6a7c-4b4d-8f28-dcce2a5f5a1e":{"description":"Authentication required","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false on errors","example":false,"uniqueKey":"success","typeLabel":"boolean"},"statusCode":{"type":"number","example":401,"uniqueKey":"statusCode","typeLabel":"number"},"error":{"type":"string","example":"Unauthorized","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","example":"Authentication required","uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable error code — switch on this, not on message text","example":"UNAUTHORIZED","uniqueKey":"code","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"statusCode":401,"error":"Unauthorized","message":"Authentication required","code":"UNAUTHORIZED"}}},"exampleType":"generated"}},"exampleType":"generated"},"bbb2be05-744d-4274-9438-df00eb8dc294":{"description":"Forbidden - Admin access required","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","example":403,"uniqueKey":"statusCode","typeLabel":"number"},"error":{"type":"string","example":"Forbidden","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","example":"Admin access required","uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","example":"ADMIN_REQUIRED","uniqueKey":"code","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":403,"error":"Forbidden","message":"Admin access required","code":"ADMIN_REQUIRED"}}},"exampleType":"generated"}},"exampleType":"generated"},"aec59ecc-951c-461b-aa05-d775e7ca804a":{"description":"Conflict - Rule name already exists. Also `IDEMPOTENCY_KEY_REUSED` (the `Idempotency-Key` was used with a different body), `IDEMPOTENCY_KEY_IN_PROGRESS` (a request with the same key is still running) or `IDEMPOTENCY_KEY_COMPLETED` (the request with this key already completed and its response is not available again).","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","example":409,"uniqueKey":"statusCode","typeLabel":"number"},"error":{"type":"string","example":"Conflict","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","example":"A trading rule with this name already exists","uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","example":"RULE_NAME_EXISTS","uniqueKey":"code","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":409,"error":"Conflict","message":"A trading rule with this name already exists","code":"RULE_NAME_EXISTS"}}},"exampleType":"generated"}},"exampleType":"generated"},"008f8b7a-f5f1-4e7b-adcc-d8f49c533b64":{"description":"An unexpected error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false on errors","example":false,"uniqueKey":"success","typeLabel":"boolean"},"statusCode":{"type":"number","example":500,"uniqueKey":"statusCode","typeLabel":"number"},"error":{"type":"string","example":"Internal Server Error","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","example":"An unexpected error occurred","uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable error code — switch on this, not on message text","example":"INTERNAL_ERROR","uniqueKey":"code","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"statusCode":500,"error":"Internal Server Error","message":"An unexpected error occurred","code":"INTERNAL_ERROR"}}},"exampleType":"generated"}},"exampleType":"generated"},"37dc468e-2539-4cfe-8437-3896ad5b0caf":{"description":"The `Idempotency-Key` could not be recorded, so the request was not run (`IDEMPOTENCY_UNAVAILABLE`). Retry with the same key after the `Retry-After` seconds.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false on errors","example":false,"uniqueKey":"success","typeLabel":"boolean"},"statusCode":{"type":"integer","example":503,"uniqueKey":"statusCode","typeLabel":"integer"},"error":{"type":"string","example":"Service Unavailable","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","example":"The Idempotency-Key could not be recorded, so the request was not run. Retry with the same key.","uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","enum":["IDEMPOTENCY_UNAVAILABLE"],"example":"IDEMPOTENCY_UNAVAILABLE","description":"Machine-readable error code — switch on this, not on message text","uniqueKey":"code","typeLabel":"enum\u003cstring>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"statusCode":503,"error":"Service Unavailable","message":"The Idempotency-Key could not be recorded, so the request was not run. Retry with the same key.","code":"IDEMPOTENCY_UNAVAILABLE"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"e1744501-32c7-43c4-8413-6774ac3f96ab":{"X-API-Key":{"type":"apiKey","name":"X-API-Key","in":"header","description":"Organization API key (`hp_live_...`), sent in the `X-API-Key` header. Create, rotate and restrict keys in the dashboard or with the API keys endpoints; an organization can have two active keys, so you can rotate without downtime. A **full-access** key can call every endpoint in this reference. A **read-only** key can call `GET` endpoints (and create a trading stream token); any other request returns `403 READ_ONLY_KEY`. A key with an IP allowlist returns `403 IP_NOT_ALLOWED` from any other address. Each endpoint lists which keys can call it under **Access**.","scopes":[],"schemeName":"X-API-Key"}}},"servers":{"b949171f-b56e-4c69-b8a6-d819dee3b071":{"url":"https://api.hyperprop.com/platform","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","name":"X-API-Key","in":"header","description":"Organization API key (`hp_live_...`), sent in the `X-API-Key` header. Create, rotate and restrict keys in the dashboard or with the API keys endpoints; an organization can have two active keys, so you can rotate without downtime. A **full-access** key can call every endpoint in this reference. A **read-only** key can call `GET` endpoints (and create a trading stream token); any other request returns `403 READ_ONLY_KEY`. A key with an IP allowlist returns `403 IP_NOT_ALLOWED` from any other address. Each endpoint lists which keys can call it under **Access**.","scopes":[],"schemeName":"X-API-Key"},"schema":{"title":"X-API-Key","type":"string","description":"Organization API key (`hp_live_...`), sent in the `X-API-Key` header. Create, rotate and restrict keys in the dashboard or with the API keys endpoints; an organization can have two active keys, so you can rotate without downtime. A **full-access** key can call every endpoint in this reference. A **read-only** key can call `GET` endpoints (and create a trading stream token); any other request returns `403 READ_ONLY_KEY`. A key with an IP allowlist returns `403 IP_NOT_ALLOWED` from any other address. Each endpoint lists which keys can call it under **Access**.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"X-API-Key","name":"X-API-Key"}],"title":"X-API-Key"}]},"originalFileLocation":"https://api.hyperprop.com/platform/openapi.json"},"subdomain":"hyperprop-401fc39d","siteName":"Hyperprop Platform API","title":"Create a new trading rule - Hyperprop Platform API","relatedPagesConfig":{"enabled":true,"limit":5,"mode":"automatic"},"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-15T15:41:09.852Z","originalFileLocation":"platform-api/trading-rules/create-a-new-trading-rule.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"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 | | dailyProfitEnforced | bool | Engine enforces dailyProfit: the account is flattened and locked until the next trading day, without failing it. Off by default (informational) | false | | bestDayStopPct | % | Best-day stop: once the day\u0026#x27;s P\u0026amp;L, open positions included, is above this percent of profitTarget (exactly on it is allowed), the account is flattened and locked until the next trading day, without failing it. When dailyProfitEnforced is also on, the lower of the two limits applies. Requires profitTarget \u0026gt; 0. 0 = off (default) | 40 | | maxProfit | $ | Max total profit cap (0 = unlimited) | 0 | | dailyLoss | $ | Max loss allowed per day | 1000 | | dailyLossOffThreshold | $ | Daily loss limit switch-off: once an end-of-day balance (closed balance; open positions do not count) is at or above the starting balance plus this amount, dailyLoss is not enforced from the next trading day and you receive account.daily_loss_limit_off. Has no effect without dailyLoss; every other rule is unchanged. null = off (default) | 500 | | dailyLossOffMode | | while_above (default): back on from the next trading day after an end-of-day balance below the target (account.daily_loss_limit_on). permanent: off until the account is reset | while_above | | dailyLossEntryBufferTicks | ticks | Daily-loss entry buffer: a new entry is refused when the room left under dailyLoss does not cover its round-trip fees plus this many ticks per contract. Exits are never refused. 0 = off (default) | 4 | | maxLoss | $ | Max total loss from starting balance | 2500 | | dailyDrawdown | % | Max daily loss as a whole-number percent of the day\u0026#x27;s starting balance, open P\u0026amp;L included (2 = 2%) | 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 | | maxPositionByProduct | count per root | Per-product position cap in that product\u0026#x27;s own contracts, per side (open positions plus working entry orders); exits always allowed; applies on top of maxContracts, stricter wins; none by default | {\u0026quot;SIL\u0026quot;: 5} | | blockedSymbols | roots | Contract roots that cannot be opened on this rule set (e.g. a micros-only plan blocks ES, NQ, YM, RTY, CL, GC). Exits always allowed; empty = nothing blocked | [\u0026quot;ES\u0026quot;, \u0026quot;NQ\u0026quot;] | | sessionWindowStart / sessionWindowEnd | HH:MM | Trading session for this rule set, e.g. a New York session product. Outside it new positions are refused (OUTSIDE_TRADING_SESSION) while closing or reducing stays allowed; at the session end open positions are closed. Set both or neither; omit for no session (default) | \u0026quot;09:30\u0026quot; / \u0026quot;16:00\u0026quot; | | sessionWindowTimezone | IANA zone | Time zone of the session times, daylight-saving aware (default America/New_York) | \u0026quot;America/New_York\u0026quot; | | maxAccountDays | days | Hard time limit: an in-progress account that has not passed by the end of this many calendar days from activation fails with ruleType time_limit_exceeded. Activation is when the trader redeemed the import key, or account creation for accounts created for their trader; that day is day 1. The clock runs whether or not the account trades and resets do not restart it. Days roll at 17:00 CT. 0 = no time limit (default) | 30 | | maxInactiveDays | days | Inactivity: the account fails with ruleType inactivity after this many consecutive calendar days without a fill (counted from the last fill, or from the start if there is none; an open position counts as activity). 0 = off (default) | 10 | | timeLimitExtensionDays | days | One-time extension of maxAccountDays: an in-progress account that reaches the end of its time limit with total profit (open positions included) strictly above timeLimitExtensionMinProgressPct % of profitTarget gets this many more days instead of failing, and you receive account.time_limit_extended. Decided once per account; after the extended deadline the account fails with ruleType time_limit_exceeded. 0 = off (default) | 30 | | timeLimitExtensionMinProgressPct | % | Progress needed for the extension, 0-100 % of profitTarget, strictly above (with a $3,000 target and 50, $1,500.01 qualifies, $1,500 does not). Default 0 | 50 | | scalingPlan | | Profit-based contract scaling tiers (see below) | { \u0026quot;tiers\u0026quot;: [...] } | | metadata | | Custom organization data | { \u0026quot;version\u0026quot;: \u0026quot;1.0\u0026quot; } | 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). Trading session (sessionWindowStart, sessionWindowEnd, sessionWindowTimezone): Restricts accounts on this rule set to a daily trading session, so one organization can sell a full-session product and, say, a New York session product (09:30–16:00 America/New_York) side by side. Off by default: with no session set, trading follows the market hours and your organization\u0026#x27;s session settings exactly as before. - Outside the session, new positions are refused with error code OUTSIDE_TRADING_SESSION. Closing or reducing a position, cancelling orders and take-profit / stop-loss exits are always allowed. - At the session end, open positions are closed and working orders are cancelled. - The session is evaluated every day in its own time zone and follows daylight saving time. An end earlier than the start is an overnight session (e.g. 18:00 → 02:00). - It only narrows trading: the market\u0026#x27;s hours and your organization\u0026#x27;s session open delay and close buffer still apply, so trading is allowed only where they overlap. - Set sessionWindowStart and sessionWindowEnd together (24-hour HH:MM); send both as null to remove the session. The time zone defaults to America/New_York. 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\u0026#x27;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\u0026#x27;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 { \u0026quot;maxContracts\u0026quot;: 10, \u0026quot;microConversionRatio\u0026quot;: 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 { \u0026quot;name\u0026quot;: \u0026quot;50K BTC Perp\u0026quot;, \u0026quot;maxLoss\u0026quot;: 2000, \u0026quot;dailyLoss\u0026quot;: 1000, \u0026quot;maxPositionByMarket\u0026quot;: { \u0026quot;BINANCE\u0026quot;: 0.5 } } That is half a Bitcoin — no conversion, no engine units. Rejections quote it back the same way: \u0026gt; Order would exceed the BINANCE position limit on this account: 0.600 BTC \u0026gt; requested, limit 0.500 BTC. | Field | Counts in | Scope | Use for | |---|---|---|---| | maxPositionByMarket | the market\u0026#x27;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\u0026#x27;s position size as they make profit: json { \u0026quot;scalingPlan\u0026quot;: { \u0026quot;basis\u0026quot;: \u0026quot;balance\u0026quot;, \u0026quot;tiers\u0026quot;: [ { \u0026quot;profit\u0026quot;: 0, \u0026quot;maxContracts\u0026quot;: 1 }, { \u0026quot;profit\u0026quot;: 1000, \u0026quot;maxContracts\u0026quot;: 2 }, { \u0026quot;profit\u0026quot;: 3000, \u0026quot;maxContracts\u0026quot;: 5.5 } ] } } - profit is in dollars relative to the account\u0026#x27;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 { \u0026quot;tiers\u0026quot;: [ { \u0026quot;balance\u0026quot;: 50000, \u0026quot;maxContracts\u0026quot;: 1 }, { \u0026quot;balance\u0026quot;: 55000, \u0026quot;maxContracts\u0026quot;: 2 }, { \u0026quot;balance\u0026quot;: 60000, \u0026quot;maxContracts\u0026quot;: 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 (\u0026quot;scalingPlan\u0026quot;: 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\u0026#x27;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\u0026#x27;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 — a consistency-enforced template: { \u0026quot;consistency\u0026quot;: 50, \u0026quot;consistencyEnforced\u0026quot;: true, \u0026quot;consistencyTolerancePct\u0026quot;: 0.2 } on evaluation rules, and { \u0026quot;consistency\u0026quot;: 50, \u0026quot;consistencyEnforced\u0026quot;: true, \u0026quot;consistencyLeniency\u0026quot;: 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. { \u0026quot;dailyLoss\u0026quot;: 1500, \u0026quot;maxLoss\u0026quot;: 2500, \u0026quot;maxContracts\u0026quot;: 5, \u0026quot;consistency\u0026quot;: 50, \u0026quot;consistencyEnforced\u0026quot;: true, \u0026quot;consistencyLeniency\u0026quot;: 40, \u0026quot;maxPayouts\u0026quot;: 5, \u0026quot;payoutMllLockOffset\u0026quot;: 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\u0026#x27;t \u0026quot;pass\u0026quot; — so it is safe to reuse an eval-style rule set on funded accounts. Example: bash curl -X POST \u0026quot;https://api.hyperprop.com/platform/v1/organization/trading-rules\u0026quot; \\ -H \u0026quot;X-API-Key: hp_live_your_key_here\u0026quot; \\ -H \u0026quot;Content-Type: application/json\u0026quot; \\ -d \u0026#x27;{ \u0026quot;name\u0026quot;: \u0026quot;Aggressive 100K Challenge\u0026quot;, \u0026quot;description\u0026quot;: \u0026quot;High risk tolerance for experienced traders\u0026quot;, \u0026quot;profitTarget\u0026quot;: 10000, \u0026quot;maxLoss\u0026quot;: 5000, \u0026quot;maxDrawdown\u0026quot;: 5000, \u0026quot;dailyLoss\u0026quot;: 2500, \u0026quot;maxContracts\u0026quot;: 15, \u0026quot;microConversionRatio\u0026quot;: 5, \u0026quot;metadata\u0026quot;: { \u0026quot;tier\u0026quot;: \u0026quot;advanced\u0026quot;, \u0026quot;version\u0026quot;: \u0026quot;1.0\u0026quot; } }\u0026#x27; Error Codes: | Code | Description | |------|-------------| | RULE_NAME_EXISTS | A rule with this name already exists | | ADMIN_REQUIRED | Only admins can create rules | Access: full-access API keys only (a read-only key gets 403 READ_ONLY_KEY). Dashboard members need manage access to Plans \u0026amp; rules.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Hyperprop Platform API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hyperprop-401fc39d/E21rb6hoYD-Zo_QV/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/hyperprop-401fc39d/E21rb6hoYD-Zo_QV/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hyperprop-401fc39d/E21rb6hoYD-Zo_QV/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/hyperprop-401fc39d/E21rb6hoYD-Zo_QV/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/hyperprop-401fc39d/E21rb6hoYD-Zo_QV/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hyperprop-401fc39d/E21rb6hoYD-Zo_QV/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hyperprop-401fc39d/E21rb6hoYD-Zo_QV/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/hyperprop-401fc39d/E21rb6hoYD-Zo_QV/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/hyperprop-401fc39d/E21rb6hoYD-Zo_QV/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a new trading rule - Hyperprop Platform API\">\u003cmeta data-mint-head property=\"og:description\" content=\"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 | | dailyProfitEnforced | bool | Engine enforces dailyProfit: the account is flattened and locked until the next trading day, without failing it. Off by default (informational) | false | | bestDayStopPct | % | Best-day stop: once the day\u0026#x27;s P\u0026amp;L, open positions included, is above this percent of profitTarget (exactly on it is allowed), the account is flattened and locked until the next trading day, without failing it. When dailyProfitEnforced is also on, the lower of the two limits applies. Requires profitTarget \u0026gt; 0. 0 = off (default) | 40 | | maxProfit | $ | Max total profit cap (0 = unlimited) | 0 | | dailyLoss | $ | Max loss allowed per day | 1000 | | dailyLossOffThreshold | $ | Daily loss limit switch-off: once an end-of-day balance (closed balance; open positions do not count) is at or above the starting balance plus this amount, dailyLoss is not enforced from the next trading day and you receive account.daily_loss_limit_off. Has no effect without dailyLoss; every other rule is unchanged. null = off (default) | 500 | | dailyLossOffMode | | while_above (default): back on from the next trading day after an end-of-day balance below the target (account.daily_loss_limit_on). permanent: off until the account is reset | while_above | | dailyLossEntryBufferTicks | ticks | Daily-loss entry buffer: a new entry is refused when the room left under dailyLoss does not cover its round-trip fees plus this many ticks per contract. Exits are never refused. 0 = off (default) | 4 | | maxLoss | $ | Max total loss from starting balance | 2500 | | dailyDrawdown | % | Max daily loss as a whole-number percent of the day\u0026#x27;s starting balance, open P\u0026amp;L included (2 = 2%) | 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 | | maxPositionByProduct | count per root | Per-product position cap in that product\u0026#x27;s own contracts, per side (open positions plus working entry orders); exits always allowed; applies on top of maxContracts, stricter wins; none by default | {\u0026quot;SIL\u0026quot;: 5} | | blockedSymbols | roots | Contract roots that cannot be opened on this rule set (e.g. a micros-only plan blocks ES, NQ, YM, RTY, CL, GC). Exits always allowed; empty = nothing blocked | [\u0026quot;ES\u0026quot;, \u0026quot;NQ\u0026quot;] | | sessionWindowStart / sessionWindowEnd | HH:MM | Trading session for this rule set, e.g. a New York session product. Outside it new positions are refused (OUTSIDE_TRADING_SESSION) while closing or reducing stays allowed; at the session end open positions are closed. Set both or neither; omit for no session (default) | \u0026quot;09:30\u0026quot; / \u0026quot;16:00\u0026quot; | | sessionWindowTimezone | IANA zone | Time zone of the session times, daylight-saving aware (default America/New_York) | \u0026quot;America/New_York\u0026quot; | | maxAccountDays | days | Hard time limit: an in-progress account that has not passed by the end of this many calendar days from activation fails with ruleType time_limit_exceeded. Activation is when the trader redeemed the import key, or account creation for accounts created for their trader; that day is day 1. The clock runs whether or not the account trades and resets do not restart it. Days roll at 17:00 CT. 0 = no time limit (default) | 30 | | maxInactiveDays | days | Inactivity: the account fails with ruleType inactivity after this many consecutive calendar days without a fill (counted from the last fill, or from the start if there is none; an open position counts as activity). 0 = off (default) | 10 | | timeLimitExtensionDays | days | One-time extension of maxAccountDays: an in-progress account that reaches the end of its time limit with total profit (open positions included) strictly above timeLimitExtensionMinProgressPct % of profitTarget gets this many more days instead of failing, and you receive account.time_limit_extended. Decided once per account; after the extended deadline the account fails with ruleType time_limit_exceeded. 0 = off (default) | 30 | | timeLimitExtensionMinProgressPct | % | Progress needed for the extension, 0-100 % of profitTarget, strictly above (with a $3,000 target and 50, $1,500.01 qualifies, $1,500 does not). Default 0 | 50 | | scalingPlan | | Profit-based contract scaling tiers (see below) | { \u0026quot;tiers\u0026quot;: [...] } | | metadata | | Custom organization data | { \u0026quot;version\u0026quot;: \u0026quot;1.0\u0026quot; } | 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). Trading session (sessionWindowStart, sessionWindowEnd, sessionWindowTimezone): Restricts accounts on this rule set to a daily trading session, so one organization can sell a full-session product and, say, a New York session product (09:30–16:00 America/New_York) side by side. Off by default: with no session set, trading follows the market hours and your organization\u0026#x27;s session settings exactly as before. - Outside the session, new positions are refused with error code OUTSIDE_TRADING_SESSION. Closing or reducing a position, cancelling orders and take-profit / stop-loss exits are always allowed. - At the session end, open positions are closed and working orders are cancelled. - The session is evaluated every day in its own time zone and follows daylight saving time. An end earlier than the start is an overnight session (e.g. 18:00 → 02:00). - It only narrows trading: the market\u0026#x27;s hours and your organization\u0026#x27;s session open delay and close buffer still apply, so trading is allowed only where they overlap. - Set sessionWindowStart and sessionWindowEnd together (24-hour HH:MM); send both as null to remove the session. The time zone defaults to America/New_York. 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\u0026#x27;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\u0026#x27;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 { \u0026quot;maxContracts\u0026quot;: 10, \u0026quot;microConversionRatio\u0026quot;: 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 { \u0026quot;name\u0026quot;: \u0026quot;50K BTC Perp\u0026quot;, \u0026quot;maxLoss\u0026quot;: 2000, \u0026quot;dailyLoss\u0026quot;: 1000, \u0026quot;maxPositionByMarket\u0026quot;: { \u0026quot;BINANCE\u0026quot;: 0.5 } } That is half a Bitcoin — no conversion, no engine units. Rejections quote it back the same way: \u0026gt; Order would exceed the BINANCE position limit on this account: 0.600 BTC \u0026gt; requested, limit 0.500 BTC. | Field | Counts in | Scope | Use for | |---|---|---|---| | maxPositionByMarket | the market\u0026#x27;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\u0026#x27;s position size as they make profit: json { \u0026quot;scalingPlan\u0026quot;: { \u0026quot;basis\u0026quot;: \u0026quot;balance\u0026quot;, \u0026quot;tiers\u0026quot;: [ { \u0026quot;profit\u0026quot;: 0, \u0026quot;maxContracts\u0026quot;: 1 }, { \u0026quot;profit\u0026quot;: 1000, \u0026quot;maxContracts\u0026quot;: 2 }, { \u0026quot;profit\u0026quot;: 3000, \u0026quot;maxContracts\u0026quot;: 5.5 } ] } } - profit is in dollars relative to the account\u0026#x27;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 { \u0026quot;tiers\u0026quot;: [ { \u0026quot;balance\u0026quot;: 50000, \u0026quot;maxContracts\u0026quot;: 1 }, { \u0026quot;balance\u0026quot;: 55000, \u0026quot;maxContracts\u0026quot;: 2 }, { \u0026quot;balance\u0026quot;: 60000, \u0026quot;maxContracts\u0026quot;: 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 (\u0026quot;scalingPlan\u0026quot;: 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\u0026#x27;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\u0026#x27;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 — a consistency-enforced template: { \u0026quot;consistency\u0026quot;: 50, \u0026quot;consistencyEnforced\u0026quot;: true, \u0026quot;consistencyTolerancePct\u0026quot;: 0.2 } on evaluation rules, and { \u0026quot;consistency\u0026quot;: 50, \u0026quot;consistencyEnforced\u0026quot;: true, \u0026quot;consistencyLeniency\u0026quot;: 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. { \u0026quot;dailyLoss\u0026quot;: 1500, \u0026quot;maxLoss\u0026quot;: 2500, \u0026quot;maxContracts\u0026quot;: 5, \u0026quot;consistency\u0026quot;: 50, \u0026quot;consistencyEnforced\u0026quot;: true, \u0026quot;consistencyLeniency\u0026quot;: 40, \u0026quot;maxPayouts\u0026quot;: 5, \u0026quot;payoutMllLockOffset\u0026quot;: 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\u0026#x27;t \u0026quot;pass\u0026quot; — so it is safe to reuse an eval-style rule set on funded accounts. Example: bash curl -X POST \u0026quot;https://api.hyperprop.com/platform/v1/organization/trading-rules\u0026quot; \\ -H \u0026quot;X-API-Key: hp_live_your_key_here\u0026quot; \\ -H \u0026quot;Content-Type: application/json\u0026quot; \\ -d \u0026#x27;{ \u0026quot;name\u0026quot;: \u0026quot;Aggressive 100K Challenge\u0026quot;, \u0026quot;description\u0026quot;: \u0026quot;High risk tolerance for experienced traders\u0026quot;, \u0026quot;profitTarget\u0026quot;: 10000, \u0026quot;maxLoss\u0026quot;: 5000, \u0026quot;maxDrawdown\u0026quot;: 5000, \u0026quot;dailyLoss\u0026quot;: 2500, \u0026quot;maxContracts\u0026quot;: 15, \u0026quot;microConversionRatio\u0026quot;: 5, \u0026quot;metadata\u0026quot;: { \u0026quot;tier\u0026quot;: \u0026quot;advanced\u0026quot;, \u0026quot;version\u0026quot;: \u0026quot;1.0\u0026quot; } }\u0026#x27; Error Codes: | Code | Description | |------|-------------| | RULE_NAME_EXISTS | A rule with this name already exists | | ADMIN_REQUIRED | Only admins can create rules | Access: full-access API keys only (a read-only key gets 403 READ_ONLY_KEY). Dashboard members need manage access to Plans \u0026amp; rules.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Hyperprop Platform API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.hyperprop.com/platform-api/trading-rules/create-a-new-trading-rule\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://hyperprop-401fc39d.mintlify.site/_mintlify/api/og/v2?division=Trading+rules\u0026amp;title=Create+a+new+trading+rule\u0026amp;description=Create+a+new+trading+rule+for+your+organization.+**Admin+only**.%0A%0A**Required+fields%3A**%0A-+%60name%60+-+Must+be+unique+within+your+organization%0A%0A**Optional+rule+param\u0026amp;theme=09948cbc21d4dec195ff5794\u0026amp;signature=c47411d1714b4d4282a0f9021891b4e48065d09cfdb5aa0c1a08618c4698297a\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create a new trading rule - Hyperprop Platform API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"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 | | dailyProfitEnforced | bool | Engine enforces dailyProfit: the account is flattened and locked until the next trading day, without failing it. Off by default (informational) | false | | bestDayStopPct | % | Best-day stop: once the day\u0026#x27;s P\u0026amp;L, open positions included, is above this percent of profitTarget (exactly on it is allowed), the account is flattened and locked until the next trading day, without failing it. When dailyProfitEnforced is also on, the lower of the two limits applies. Requires profitTarget \u0026gt; 0. 0 = off (default) | 40 | | maxProfit | $ | Max total profit cap (0 = unlimited) | 0 | | dailyLoss | $ | Max loss allowed per day | 1000 | | dailyLossOffThreshold | $ | Daily loss limit switch-off: once an end-of-day balance (closed balance; open positions do not count) is at or above the starting balance plus this amount, dailyLoss is not enforced from the next trading day and you receive account.daily_loss_limit_off. Has no effect without dailyLoss; every other rule is unchanged. null = off (default) | 500 | | dailyLossOffMode | | while_above (default): back on from the next trading day after an end-of-day balance below the target (account.daily_loss_limit_on). permanent: off until the account is reset | while_above | | dailyLossEntryBufferTicks | ticks | Daily-loss entry buffer: a new entry is refused when the room left under dailyLoss does not cover its round-trip fees plus this many ticks per contract. Exits are never refused. 0 = off (default) | 4 | | maxLoss | $ | Max total loss from starting balance | 2500 | | dailyDrawdown | % | Max daily loss as a whole-number percent of the day\u0026#x27;s starting balance, open P\u0026amp;L included (2 = 2%) | 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 | | maxPositionByProduct | count per root | Per-product position cap in that product\u0026#x27;s own contracts, per side (open positions plus working entry orders); exits always allowed; applies on top of maxContracts, stricter wins; none by default | {\u0026quot;SIL\u0026quot;: 5} | | blockedSymbols | roots | Contract roots that cannot be opened on this rule set (e.g. a micros-only plan blocks ES, NQ, YM, RTY, CL, GC). Exits always allowed; empty = nothing blocked | [\u0026quot;ES\u0026quot;, \u0026quot;NQ\u0026quot;] | | sessionWindowStart / sessionWindowEnd | HH:MM | Trading session for this rule set, e.g. a New York session product. Outside it new positions are refused (OUTSIDE_TRADING_SESSION) while closing or reducing stays allowed; at the session end open positions are closed. Set both or neither; omit for no session (default) | \u0026quot;09:30\u0026quot; / \u0026quot;16:00\u0026quot; | | sessionWindowTimezone | IANA zone | Time zone of the session times, daylight-saving aware (default America/New_York) | \u0026quot;America/New_York\u0026quot; | | maxAccountDays | days | Hard time limit: an in-progress account that has not passed by the end of this many calendar days from activation fails with ruleType time_limit_exceeded. Activation is when the trader redeemed the import key, or account creation for accounts created for their trader; that day is day 1. The clock runs whether or not the account trades and resets do not restart it. Days roll at 17:00 CT. 0 = no time limit (default) | 30 | | maxInactiveDays | days | Inactivity: the account fails with ruleType inactivity after this many consecutive calendar days without a fill (counted from the last fill, or from the start if there is none; an open position counts as activity). 0 = off (default) | 10 | | timeLimitExtensionDays | days | One-time extension of maxAccountDays: an in-progress account that reaches the end of its time limit with total profit (open positions included) strictly above timeLimitExtensionMinProgressPct % of profitTarget gets this many more days instead of failing, and you receive account.time_limit_extended. Decided once per account; after the extended deadline the account fails with ruleType time_limit_exceeded. 0 = off (default) | 30 | | timeLimitExtensionMinProgressPct | % | Progress needed for the extension, 0-100 % of profitTarget, strictly above (with a $3,000 target and 50, $1,500.01 qualifies, $1,500 does not). Default 0 | 50 | | scalingPlan | | Profit-based contract scaling tiers (see below) | { \u0026quot;tiers\u0026quot;: [...] } | | metadata | | Custom organization data | { \u0026quot;version\u0026quot;: \u0026quot;1.0\u0026quot; } | 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). Trading session (sessionWindowStart, sessionWindowEnd, sessionWindowTimezone): Restricts accounts on this rule set to a daily trading session, so one organization can sell a full-session product and, say, a New York session product (09:30–16:00 America/New_York) side by side. Off by default: with no session set, trading follows the market hours and your organization\u0026#x27;s session settings exactly as before. - Outside the session, new positions are refused with error code OUTSIDE_TRADING_SESSION. Closing or reducing a position, cancelling orders and take-profit / stop-loss exits are always allowed. - At the session end, open positions are closed and working orders are cancelled. - The session is evaluated every day in its own time zone and follows daylight saving time. An end earlier than the start is an overnight session (e.g. 18:00 → 02:00). - It only narrows trading: the market\u0026#x27;s hours and your organization\u0026#x27;s session open delay and close buffer still apply, so trading is allowed only where they overlap. - Set sessionWindowStart and sessionWindowEnd together (24-hour HH:MM); send both as null to remove the session. The time zone defaults to America/New_York. 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\u0026#x27;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\u0026#x27;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 { \u0026quot;maxContracts\u0026quot;: 10, \u0026quot;microConversionRatio\u0026quot;: 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 { \u0026quot;name\u0026quot;: \u0026quot;50K BTC Perp\u0026quot;, \u0026quot;maxLoss\u0026quot;: 2000, \u0026quot;dailyLoss\u0026quot;: 1000, \u0026quot;maxPositionByMarket\u0026quot;: { \u0026quot;BINANCE\u0026quot;: 0.5 } } That is half a Bitcoin — no conversion, no engine units. Rejections quote it back the same way: \u0026gt; Order would exceed the BINANCE position limit on this account: 0.600 BTC \u0026gt; requested, limit 0.500 BTC. | Field | Counts in | Scope | Use for | |---|---|---|---| | maxPositionByMarket | the market\u0026#x27;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\u0026#x27;s position size as they make profit: json { \u0026quot;scalingPlan\u0026quot;: { \u0026quot;basis\u0026quot;: \u0026quot;balance\u0026quot;, \u0026quot;tiers\u0026quot;: [ { \u0026quot;profit\u0026quot;: 0, \u0026quot;maxContracts\u0026quot;: 1 }, { \u0026quot;profit\u0026quot;: 1000, \u0026quot;maxContracts\u0026quot;: 2 }, { \u0026quot;profit\u0026quot;: 3000, \u0026quot;maxContracts\u0026quot;: 5.5 } ] } } - profit is in dollars relative to the account\u0026#x27;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 { \u0026quot;tiers\u0026quot;: [ { \u0026quot;balance\u0026quot;: 50000, \u0026quot;maxContracts\u0026quot;: 1 }, { \u0026quot;balance\u0026quot;: 55000, \u0026quot;maxContracts\u0026quot;: 2 }, { \u0026quot;balance\u0026quot;: 60000, \u0026quot;maxContracts\u0026quot;: 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 (\u0026quot;scalingPlan\u0026quot;: 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\u0026#x27;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\u0026#x27;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 — a consistency-enforced template: { \u0026quot;consistency\u0026quot;: 50, \u0026quot;consistencyEnforced\u0026quot;: true, \u0026quot;consistencyTolerancePct\u0026quot;: 0.2 } on evaluation rules, and { \u0026quot;consistency\u0026quot;: 50, \u0026quot;consistencyEnforced\u0026quot;: true, \u0026quot;consistencyLeniency\u0026quot;: 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. { \u0026quot;dailyLoss\u0026quot;: 1500, \u0026quot;maxLoss\u0026quot;: 2500, \u0026quot;maxContracts\u0026quot;: 5, \u0026quot;consistency\u0026quot;: 50, \u0026quot;consistencyEnforced\u0026quot;: true, \u0026quot;consistencyLeniency\u0026quot;: 40, \u0026quot;maxPayouts\u0026quot;: 5, \u0026quot;payoutMllLockOffset\u0026quot;: 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\u0026#x27;t \u0026quot;pass\u0026quot; — so it is safe to reuse an eval-style rule set on funded accounts. Example: bash curl -X POST \u0026quot;https://api.hyperprop.com/platform/v1/organization/trading-rules\u0026quot; \\ -H \u0026quot;X-API-Key: hp_live_your_key_here\u0026quot; \\ -H \u0026quot;Content-Type: application/json\u0026quot; \\ -d \u0026#x27;{ \u0026quot;name\u0026quot;: \u0026quot;Aggressive 100K Challenge\u0026quot;, \u0026quot;description\u0026quot;: \u0026quot;High risk tolerance for experienced traders\u0026quot;, \u0026quot;profitTarget\u0026quot;: 10000, \u0026quot;maxLoss\u0026quot;: 5000, \u0026quot;maxDrawdown\u0026quot;: 5000, \u0026quot;dailyLoss\u0026quot;: 2500, \u0026quot;maxContracts\u0026quot;: 15, \u0026quot;microConversionRatio\u0026quot;: 5, \u0026quot;metadata\u0026quot;: { \u0026quot;tier\u0026quot;: \u0026quot;advanced\u0026quot;, \u0026quot;version\u0026quot;: \u0026quot;1.0\u0026quot; } }\u0026#x27; Error Codes: | Code | Description | |------|-------------| | RULE_NAME_EXISTS | A rule with this name already exists | | ADMIN_REQUIRED | Only admins can create rules | Access: full-access API keys only (a read-only key gets 403 READ_ONLY_KEY). Dashboard members need manage access to Plans \u0026amp; rules.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://hyperprop-401fc39d.mintlify.site/_mintlify/api/og/v2?division=Trading+rules\u0026amp;title=Create+a+new+trading+rule\u0026amp;description=Create+a+new+trading+rule+for+your+organization.+**Admin+only**.%0A%0A**Required+fields%3A**%0A-+%60name%60+-+Must+be+unique+within+your+organization%0A%0A**Optional+rule+param\u0026amp;theme=09948cbc21d4dec195ff5794\u0026amp;signature=c47411d1714b4d4282a0f9021891b4e48065d09cfdb5aa0c1a08618c4698297a\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/hyperprop-401fc39d/E21rb6hoYD-Zo_QV/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Hyperprop Platform API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#253CFF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.hyperprop.com/platform-api/trading-rules/create-a-new-trading-rule\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/platform-api/trading-rules/create-a-new-trading-rule.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.hyperprop.com/#organization\",\"name\":\"Hyperprop Platform API\",\"url\":\"https://docs.hyperprop.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/hyperprop-401fc39d/snMIX7SYzcFqAv9j/logo/light.svg?fit=max\u0026auto=format\u0026n=snMIX7SYzcFqAv9j\u0026q=85\u0026s=e3a0a071fb4ba3ae53ef978c23cc38a3\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.hyperprop.com#website\",\"name\":\"Hyperprop Platform API\",\"url\":\"https://docs.hyperprop.com\",\"publisher\":{\"@id\":\"https://docs.hyperprop.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.hyperprop.com/platform-api/trading-rules/create-a-new-trading-rule#webpage\",\"url\":\"https://docs.hyperprop.com/platform-api/trading-rules/create-a-new-trading-rule\",\"name\":\"Create a new trading rule\",\"description\":\"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 | | dailyProfitEnforced | bool | Engine enforces dailyProfit: the account is flattened and locked until the next trading day, without failing it. Off by default (informational) | false | | bestDayStopPct | % | Best-day stop: once the day's P\u0026L, open positions included, is above this percent of profitTarget (exactly on it is allowed), the account is flattened and locked until the next trading day, without failing it. When dailyProfitEnforced is also on, the lower of the two limits applies. Requires profitTarget > 0. 0 = off (default) | 40 | | maxProfit | $ | Max total profit cap (0 = unlimited) | 0 | | dailyLoss | $ | Max loss allowed per day | 1000 | | dailyLossOffThreshold | $ | Daily loss limit switch-off: once an end-of-day balance (closed balance; open positions do not count) is at or above the starting balance plus this amount, dailyLoss is not enforced from the next trading day and you receive account.daily_loss_limit_off. Has no effect without dailyLoss; every other rule is unchanged. null = off (default) | 500 | | dailyLossOffMode | | while_above (default): back on from the next trading day after an end-of-day balance below the target (account.daily_loss_limit_on). permanent: off until the account is reset | while_above | | dailyLossEntryBufferTicks | ticks | Daily-loss entry buffer: a new entry is refused when the room left under dailyLoss does not cover its round-trip fees plus this many ticks per contract. Exits are never refused. 0 = off (default) | 4 | | maxLoss | $ | Max total loss from starting balance | 2500 | | dailyDrawdown | % | Max daily loss as a whole-number percent of the day's starting balance, open P\u0026L included (2 = 2%) | 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 | | maxPositionByProduct | count per root | Per-product position cap in that product's own contracts, per side (open positions plus working entry orders); exits always allowed; applies on top of maxContracts, stricter wins; none by default | {\\\"SIL\\\": 5} | | blockedSymbols | roots | Contract roots that cannot be opened on this rule set (e.g. a micros-only plan blocks ES, NQ, YM, RTY, CL, GC). Exits always allowed; empty = nothing blocked | [\\\"ES\\\", \\\"NQ\\\"] | | sessionWindowStart / sessionWindowEnd | HH:MM | Trading session for this rule set, e.g. a New York session product. Outside it new positions are refused (OUTSIDE_TRADING_SESSION) while closing or reducing stays allowed; at the session end open positions are closed. Set both or neither; omit for no session (default) | \\\"09:30\\\" / \\\"16:00\\\" | | sessionWindowTimezone | IANA zone | Time zone of the session times, daylight-saving aware (default America/New_York) | \\\"America/New_York\\\" | | maxAccountDays | days | Hard time limit: an in-progress account that has not passed by the end of this many calendar days from activation fails with ruleType time_limit_exceeded. Activation is when the trader redeemed the import key, or account creation for accounts created for their trader; that day is day 1. The clock runs whether or not the account trades and resets do not restart it. Days roll at 17:00 CT. 0 = no time limit (default) | 30 | | maxInactiveDays | days | Inactivity: the account fails with ruleType inactivity after this many consecutive calendar days without a fill (counted from the last fill, or from the start if there is none; an open position counts as activity). 0 = off (default) | 10 | | timeLimitExtensionDays | days | One-time extension of maxAccountDays: an in-progress account that reaches the end of its time limit with total profit (open positions included) strictly above timeLimitExtensionMinProgressPct % of profitTarget gets this many more days instead of failing, and you receive account.time_limit_extended. Decided once per account; after the extended deadline the account fails with ruleType time_limit_exceeded. 0 = off (default) | 30 | | timeLimitExtensionMinProgressPct | % | Progress needed for the extension, 0-100 % of profitTarget, strictly above (with a $3,000 target and 50, $1,500.01 qualifies, $1,500 does not). Default 0 | 50 | | 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). Trading session (sessionWindowStart, sessionWindowEnd, sessionWindowTimezone): Restricts accounts on this rule set to a daily trading session, so one organization can sell a full-session product and, say, a New York session product (09:30–16:00 America/New_York) side by side. Off by default: with no session set, trading follows the market hours and your organization's session settings exactly as before. - Outside the session, new positions are refused with error code OUTSIDE_TRADING_SESSION. Closing or reducing a position, cancelling orders and take-profit / stop-loss exits are always allowed. - At the session end, open positions are closed and working orders are cancelled. - The session is evaluated every day in its own time zone and follows daylight saving time. An end earlier than the start is an overnight session (e.g. 18:00 → 02:00). - It only narrows trading: the market's hours and your organization's session open delay and close buffer still apply, so trading is allowed only where they overlap. - Set sessionWindowStart and sessionWindowEnd together (24-hour HH:MM); send both as null to remove the session. The time zone defaults to America/New_York. 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 — a consistency-enforced 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.hyperprop.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 | Access: full-access API keys only (a read-only key gets 403 READ_ONLY_KEY). Dashboard members need manage access to Plans \u0026 rules.\",\"dateModified\":\"2026-11-15T15:41:09.852Z\",\"isPartOf\":{\"@id\":\"https://docs.hyperprop.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.hyperprop.com/platform-api/trading-rules/create-a-new-trading-rule#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.hyperprop.com/platform-api/trading-rules/create-a-new-trading-rule#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Platform API\",\"item\":\"https://docs.hyperprop.com/platform-api/trading-accounts/list-close-all-runs\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Trading rules\",\"item\":\"https://docs.hyperprop.com/platform-api/trading-rules/get-trading-rules-for-your-organization\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create a new trading rule\",\"item\":\"https://docs.hyperprop.com/platform-api/trading-rules/create-a-new-trading-rule\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.hyperprop.com/platform-api/trading-rules/create-a-new-trading-rule#apireference\",\"headline\":\"Create a new trading rule\",\"name\":\"Create a new trading rule\",\"description\":\"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 | | dailyProfitEnforced | bool | Engine enforces dailyProfit: the account is flattened and locked until the next trading day, without failing it. Off by default (informational) | false | | bestDayStopPct | % | Best-day stop: once the day's P\u0026L, open positions included, is above this percent of profitTarget (exactly on it is allowed), the account is flattened and locked until the next trading day, without failing it. When dailyProfitEnforced is also on, the lower of the two limits applies. Requires profitTarget > 0. 0 = off (default) | 40 | | maxProfit | $ | Max total profit cap (0 = unlimited) | 0 | | dailyLoss | $ | Max loss allowed per day | 1000 | | dailyLossOffThreshold | $ | Daily loss limit switch-off: once an end-of-day balance (closed balance; open positions do not count) is at or above the starting balance plus this amount, dailyLoss is not enforced from the next trading day and you receive account.daily_loss_limit_off. Has no effect without dailyLoss; every other rule is unchanged. null = off (default) | 500 | | dailyLossOffMode | | while_above (default): back on from the next trading day after an end-of-day balance below the target (account.daily_loss_limit_on). permanent: off until the account is reset | while_above | | dailyLossEntryBufferTicks | ticks | Daily-loss entry buffer: a new entry is refused when the room left under dailyLoss does not cover its round-trip fees plus this many ticks per contract. Exits are never refused. 0 = off (default) | 4 | | maxLoss | $ | Max total loss from starting balance | 2500 | | dailyDrawdown | % | Max daily loss as a whole-number percent of the day's starting balance, open P\u0026L included (2 = 2%) | 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 | | maxPositionByProduct | count per root | Per-product position cap in that product's own contracts, per side (open positions plus working entry orders); exits always allowed; applies on top of maxContracts, stricter wins; none by default | {\\\"SIL\\\": 5} | | blockedSymbols | roots | Contract roots that cannot be opened on this rule set (e.g. a micros-only plan blocks ES, NQ, YM, RTY, CL, GC). Exits always allowed; empty = nothing blocked | [\\\"ES\\\", \\\"NQ\\\"] | | sessionWindowStart / sessionWindowEnd | HH:MM | Trading session for this rule set, e.g. a New York session product. Outside it new positions are refused (OUTSIDE_TRADING_SESSION) while closing or reducing stays allowed; at the session end open positions are closed. Set both or neither; omit for no session (default) | \\\"09:30\\\" / \\\"16:00\\\" | | sessionWindowTimezone | IANA zone | Time zone of the session times, daylight-saving aware (default America/New_York) | \\\"America/New_York\\\" | | maxAccountDays | days | Hard time limit: an in-progress account that has not passed by the end of this many calendar days from activation fails with ruleType time_limit_exceeded. Activation is when the trader redeemed the import key, or account creation for accounts created for their trader; that day is day 1. The clock runs whether or not the account trades and resets do not restart it. Days roll at 17:00 CT. 0 = no time limit (default) | 30 | | maxInactiveDays | days | Inactivity: the account fails with ruleType inactivity after this many consecutive calendar days without a fill (counted from the last fill, or from the start if there is none; an open position counts as activity). 0 = off (default) | 10 | | timeLimitExtensionDays | days | One-time extension of maxAccountDays: an in-progress account that reaches the end of its time limit with total profit (open positions included) strictly above timeLimitExtensionMinProgressPct % of profitTarget gets this many more days instead of failing, and you receive account.time_limit_extended. Decided once per account; after the extended deadline the account fails with ruleType time_limit_exceeded. 0 = off (default) | 30 | | timeLimitExtensionMinProgressPct | % | Progress needed for the extension, 0-100 % of profitTarget, strictly above (with a $3,000 target and 50, $1,500.01 qualifies, $1,500 does not). Default 0 | 50 | | 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). Trading session (sessionWindowStart, sessionWindowEnd, sessionWindowTimezone): Restricts accounts on this rule set to a daily trading session, so one organization can sell a full-session product and, say, a New York session product (09:30–16:00 America/New_York) side by side. Off by default: with no session set, trading follows the market hours and your organization's session settings exactly as before. - Outside the session, new positions are refused with error code OUTSIDE_TRADING_SESSION. Closing or reducing a position, cancelling orders and take-profit / stop-loss exits are always allowed. - At the session end, open positions are closed and working orders are cancelled. - The session is evaluated every day in its own time zone and follows daylight saving time. An end earlier than the start is an overnight session (e.g. 18:00 → 02:00). - It only narrows trading: the market's hours and your organization's session open delay and close buffer still apply, so trading is allowed only where they overlap. - Set sessionWindowStart and sessionWindowEnd together (24-hour HH:MM); send both as null to remove the session. The time zone defaults to America/New_York. 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 — a consistency-enforced 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.hyperprop.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 | Access: full-access API keys only (a read-only key gets 403 READ_ONLY_KEY). Dashboard members need manage access to Plans \u0026 rules.\",\"url\":\"https://docs.hyperprop.com/platform-api/trading-rules/create-a-new-trading-rule\",\"mainEntityOfPage\":{\"@id\":\"https://docs.hyperprop.com/platform-api/trading-rules/create-a-new-trading-rule#webpage\"},\"dateModified\":\"2026-11-15T15:41:09.852Z\",\"publisher\":{\"@id\":\"https://docs.hyperprop.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.hyperprop.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Hyperprop Platform API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Hyperprop Platform API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/platform-api/trading-rules/create-a-new-trading-rule.md","siteName":"Hyperprop Platform API","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"Platform API","pages":[{"group":"Trading accounts","pages":[{"title":"List close-all runs","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/flatten-runs","href":"/platform-api/trading-accounts/list-close-all-runs"},{"title":"Get trading accounts for your organization","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts","href":"/platform-api/trading-accounts/get-trading-accounts-for-your-organization"},{"title":"Create a trading account","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts","href":"/platform-api/trading-accounts/create-a-trading-account"},{"title":"Get bulk operation details","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/bulk-operations/{batchId}","href":"/platform-api/trading-accounts/get-bulk-operation-details"},{"title":"Get a close-all run","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/flatten-runs/{runId}","href":"/platform-api/trading-accounts/get-a-close-all-run"},{"title":"Get active traders","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/active-traders","href":"/platform-api/trading-accounts/get-active-traders"},{"title":"Get daily account and trader activity","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/activity","href":"/platform-api/trading-accounts/get-daily-account-and-trader-activity"},{"title":"Bulk-create unlinked accounts with import keys","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/bulk","href":"/platform-api/trading-accounts/bulk-create-unlinked-accounts-with-import-keys"},{"title":"Bulk update trading accounts","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/bulk-update","href":"/platform-api/trading-accounts/bulk-update-trading-accounts"},{"title":"Close all positions across accounts","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/flatten","href":"/platform-api/trading-accounts/close-all-positions-across-accounts"},{"title":"Get open positions and equity for many accounts","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/positions","href":"/platform-api/trading-accounts/get-open-positions-and-equity-for-many-accounts"},{"title":"Get a specific trading account","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}","href":"/platform-api/trading-accounts/get-a-specific-trading-account"},{"title":"Update a trading account","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json patch /v1/organization/trading-accounts/{accountId}","href":"/platform-api/trading-accounts/update-a-trading-account"},{"title":"Get an account's event log and session history","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}/activity","href":"/platform-api/trading-accounts/get-an-accounts-event-log-and-session-history"},{"title":"List an account's balance adjustments","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}/balance-adjustments","href":"/platform-api/trading-accounts/list-an-accounts-balance-adjustments"},{"title":"Credit or debit a trading account","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/{accountId}/balance-adjustments","href":"/platform-api/trading-accounts/credit-or-debit-a-trading-account"},{"title":"Get account change history","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}/changes","href":"/platform-api/trading-accounts/get-account-change-history"},{"title":"Get an account's daily P\u0026L","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}/daily-pnl","href":"/platform-api/trading-accounts/get-an-accounts-daily-p\u0026l"},{"title":"Turn an account off (pause)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/{accountId}/deactivate","href":"/platform-api/trading-accounts/turn-an-account-off-pause"},{"title":"Get an account's equity and unrealized P\u0026L","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}/equity","href":"/platform-api/trading-accounts/get-an-accounts-equity-and-unrealized-p\u0026l"},{"title":"Close all positions on an account","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/{accountId}/flatten","href":"/platform-api/trading-accounts/close-all-positions-on-an-account"},{"title":"Get an account's order event timeline","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}/order-events","href":"/platform-api/trading-accounts/get-an-accounts-order-event-timeline"},{"title":"Get an account's order history","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}/orders","href":"/platform-api/trading-accounts/get-an-accounts-order-history"},{"title":"Get an account's open positions","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}/positions","href":"/platform-api/trading-accounts/get-an-accounts-open-positions"},{"title":"Turn an account back on","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/{accountId}/reactivate","href":"/platform-api/trading-accounts/turn-an-account-back-on"},{"title":"Unlink a trader (issues a fresh import key)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/{accountId}/unlink","href":"/platform-api/trading-accounts/unlink-a-trader-issues-a-fresh-import-key"},{"title":"Get a balance adjustment by reference","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}/balance-adjustments/{reference}","href":"/platform-api/trading-accounts/get-a-balance-adjustment-by-reference"},{"title":"Cancel working orders on an account","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/{accountId}/orders/cancel","href":"/platform-api/trading-accounts/cancel-working-orders-on-an-account"},{"title":"Close one position on an account","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/{accountId}/positions/{contract}/close","href":"/platform-api/trading-accounts/close-one-position-on-an-account"}]},{"group":"Traders","pages":[{"title":"List trader identity bindings (customer ⇄ Hyperprop login)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trader-bindings","href":"/platform-api/traders/list-trader-identity-bindings-customer-⇄-hyperprop-login"},{"title":"Get traders for your organization","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/traders","href":"/platform-api/traders/get-traders-for-your-organization"},{"title":"Get a specific trader","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/traders/{traderId}","href":"/platform-api/traders/get-a-specific-trader"},{"title":"Update a trader","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json patch /v1/organization/traders/{traderId}","href":"/platform-api/traders/update-a-trader"},{"title":"Rebind a customer to a new Hyperprop login (support flow)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trader-bindings/{bindingId}/rebind","href":"/platform-api/traders/rebind-a-customer-to-a-new-hyperprop-login-support-flow"}]},{"group":"Trading plans","pages":[{"title":"Get trading plans for your organization","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-plans","href":"/platform-api/trading-plans/get-trading-plans-for-your-organization"},{"title":"Create a new trading plan","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-plans","href":"/platform-api/trading-plans/create-a-new-trading-plan"},{"title":"Get a specific trading plan","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-plans/{planId}","href":"/platform-api/trading-plans/get-a-specific-trading-plan"},{"title":"Delete a trading plan","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json delete /v1/organization/trading-plans/{planId}","href":"/platform-api/trading-plans/delete-a-trading-plan"},{"title":"Update a trading plan","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json patch /v1/organization/trading-plans/{planId}","href":"/platform-api/trading-plans/update-a-trading-plan"}]},{"group":"Trading rules","pages":[{"title":"Get trading rules for your organization","description":"Retrieve all trading rules configured for your organization.\n\n**What are trading rules?**\nTrading rules define the constraints and targets for your evaluation accounts. They determine when a trader passes, fails, or violates their account. Rules are attached to trading plans.\n\n**Rule parameters explained:**\n\n| Parameter | Description |\n|-----------|-------------|\n| `profitTarget` | Amount trader must profit to pass (e.g., $10,000) |\n| `dailyLoss` | Max loss allowed in a single day (e.g., $2,500) |\n| `maxLoss` | Max total loss from starting balance (e.g., $5,000) |\n| `dailyDrawdown` | Max daily loss as a whole-number percent of the day's starting balance, open P\u0026L included (e.g., 2 = 2%) |\n| `maxDrawdown` | Max drawdown below the reference set by `drawdownType`; a percent, or dollars when `drawdownDenomination` is `dollars` (e.g., 5 = 5%) |\n| `maxContracts` | Max position size in mini-equivalent contracts (e.g., 10) |\n| `microConversionRatio` | How many micros count as 1 unit toward maxContracts (default 10) |\n| `consistency` | Consistency rule percentage (0 = disabled) |\n| `dailyProfit` | Max daily profit cap (0 = unlimited) |\n| `maxProfit` | Max total profit cap (0 = unlimited) |\n| `maxAccountDays` | Calendar days an account has to pass, counted from activation (0 = no time limit) |\n| `maxInactiveDays` | Consecutive calendar days without a fill before the account fails (0 = off) |\n| `timeLimitExtensionDays` | One-time extension of `maxAccountDays` for accounts above the progress threshold at the time limit (0 = off) |\n| `timeLimitExtensionMinProgressPct` | Total profit must be strictly above this % of `profitTarget` for the extension |\n| `personalRiskPolicy` | Bounds on the risk controls traders set for themselves (see below) |\n\n**Personal risk policy (`personalRiskPolicy`):**\n\nTraders can impose their own risk controls on an account — a personal daily\nloss limit (optionally trailing their session peak), a daily profit target,\nmax trades per day/week, per-symbol contract limits, symbol blocks and\nautomatic brackets. These are enforced by the trade engine in real time and\ncan only ever make an account **stricter** than your rule set.\n\n`personalRiskPolicy` lets you bound what a trader may choose:\n\n```json\n{\n \"personalRiskPolicy\": {\n \"dailyLossLimitMax\": 1000,\n \"dailyLossLimitDefault\": 500,\n \"requireDailyLossLimit\": true,\n \"maxTradesPerDayMax\": 20,\n \"requireAutoBracket\": false,\n \"lockedByFirm\": false\n }\n}\n```\n\n- Every value is a **ceiling**: a trader may always pick something stricter.\n- A ceiling is an *effective* bound, not just form validation. If the trader\n leaves the field empty, your value applies (`dailyLossLimitDefault` when\n set, otherwise `dailyLossLimitMax`) — nobody escapes a bound by leaving a\n field blank.\n- `requireDailyLossLimit` also forces the limit to be **armed**: a trader\n cannot set the action to \"do nothing\".\n- `lockedByFirm: true` makes the whole personal risk panel read-only; the\n trader's own API calls are rejected with `FIRM_LOCKED`.\n- Omit the object entirely (or send `null` on update) to leave traders\n unconstrained. Nothing changes for existing rule sets.\n\nTraders read and write their own settings through the trade API\n(`GET`/`POST /trade/account/risk-settings`); this policy is the only knob\nyou need on your side.\n\n**Example rule sets:**\n\n*Standard Challenge (beginner-friendly):*\n- Profit target: $10,000 (10%)\n- Daily loss: $2,500 (2.5%)\n- Max drawdown: $5,000 (5%)\n\n*Aggressive Challenge (experienced traders):*\n- Profit target: $8,000 (8%)\n- Daily loss: $4,000 (4%)\n- Max drawdown: $6,000 (6%)\n\n**Filtering by metadata:**\n```http\n# Find strict rule sets\nGET /organization/trading-rules?metadata=strict:true\n\n# Find rules by version\nGET /organization/trading-rules?metadata=ruleVersion:2.1\n\n# Find rules for specific markets\nGET /organization/trading-rules?metadata=market:futures\n```\n\n**Use cases:**\n- Display rule details on your website\n- Validate rule IDs before creating accounts\n- Compare different rule configurations\n- Audit your risk parameters\n\n**Access:** read-only and full-access API keys. Dashboard members need view access to Plans \u0026 rules.","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-rules","href":"/platform-api/trading-rules/get-trading-rules-for-your-organization"},{"title":"Create a new trading rule","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-rules","href":"/platform-api/trading-rules/create-a-new-trading-rule"},{"title":"Get a specific trading rule","description":"Retrieve complete details for a single trading rule by its ID.\n\n**When to use this:**\n- Display rule details on your website\n- Verify rule configuration before creating an account\n- Show rule breakdown in your admin dashboard\n\n**What you get:**\n- All rule parameters (profit target, loss limits, drawdown limits)\n- Position size limits (max contracts)\n- Consistency requirements\n- Custom metadata you've stored\n\n**Example:**\n```http\nGET /organization/trading-rules/660e8400-e29b-41d4-a716-446655440000\n```\n\n**Access:** read-only and full-access API keys. Dashboard members need view access to Plans \u0026 rules.","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-rules/{ruleId}","href":"/platform-api/trading-rules/get-a-specific-trading-rule"},{"title":"Delete a trading rule","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json delete /v1/organization/trading-rules/{ruleId}","href":"/platform-api/trading-rules/delete-a-trading-rule"},{"title":"Update a trading rule","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json patch /v1/organization/trading-rules/{ruleId}","href":"/platform-api/trading-rules/update-a-trading-rule"}]},{"group":"Instruments","pages":[{"title":"List instruments","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/instruments","href":"/platform-api/instruments/list-instruments"}]},{"group":"Lockouts","pages":[{"title":"List all active lockouts","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/lockouts","href":"/platform-api/lockouts/list-all-active-lockouts"},{"title":"Create admin lockout","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/lockouts","href":"/platform-api/lockouts/create-admin-lockout"},{"title":"Get daily lockout activity","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/lockouts/activity","href":"/platform-api/lockouts/get-daily-lockout-activity"},{"title":"Get lockout status for account","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/lockouts/{accountId}","href":"/platform-api/lockouts/get-lockout-status-for-account"},{"title":"Remove lockout from account","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json delete /v1/organization/lockouts/{accountId}","href":"/platform-api/lockouts/remove-lockout-from-account"},{"title":"Update active lockout","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json patch /v1/organization/lockouts/{accountId}","href":"/platform-api/lockouts/update-active-lockout"}]},{"group":"Payouts","pages":[{"title":"Payout queue — bulk payout eligibility","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/payout-eligibility","href":"/platform-api/payouts/payout-queue-—-bulk-payout-eligibility"},{"title":"Get daily payout activity","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/payouts/activity","href":"/platform-api/payouts/get-daily-payout-activity"},{"title":"Check payout eligibility","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/accounts/{accountId}/payout-eligibility","href":"/platform-api/payouts/check-payout-eligibility"},{"title":"List payouts for an account","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/accounts/{accountId}/payouts","href":"/platform-api/payouts/list-payouts-for-an-account"},{"title":"Execute a payout (balance withdrawal)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/accounts/{accountId}/payouts","href":"/platform-api/payouts/execute-a-payout-balance-withdrawal"},{"title":"Reverse a payout (restore the withdrawn balance)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/accounts/{accountId}/payouts/{payoutId}/reverse","href":"/platform-api/payouts/reverse-a-payout-restore-the-withdrawn-balance"}]},{"group":"Purchases","pages":[{"title":"Get purchases for your organization","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/purchases","href":"/platform-api/purchases/get-purchases-for-your-organization"},{"title":"Get a specific purchase","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/purchases/{purchaseId}","href":"/platform-api/purchases/get-a-specific-purchase"}]},{"group":"Time Machine","pages":[{"title":"List revert batches","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/revert-batches","href":"/platform-api/time-machine/list-revert-batches"},{"title":"Get revert settings","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/time-machine-settings","href":"/platform-api/time-machine/get-revert-settings"},{"title":"Update revert settings","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json put /v1/organization/time-machine-settings","href":"/platform-api/time-machine/update-revert-settings"},{"title":"Bulk revert accounts to a trading day or an instant","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/accounts/revert-trading-day","href":"/platform-api/time-machine/bulk-revert-accounts-to-a-trading-day-or-an-instant"},{"title":"Inspect a revert batch","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/revert-batches/{batchId}","href":"/platform-api/time-machine/inspect-a-revert-batch"},{"title":"Revert an account to a trading day or an instant","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/accounts/{accountId}/revert-trading-day","href":"/platform-api/time-machine/revert-an-account-to-a-trading-day-or-an-instant"},{"title":"Cancel a background run","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/revert-batches/{batchId}/cancel","href":"/platform-api/time-machine/cancel-a-background-run"},{"title":"List the accounts of a background run","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/revert-batches/{batchId}/items","href":"/platform-api/time-machine/list-the-accounts-of-a-background-run"},{"title":"Retry the failed accounts of a background run","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/revert-batches/{batchId}/retry-failed","href":"/platform-api/time-machine/retry-the-failed-accounts-of-a-background-run"},{"title":"Undo a revert batch","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/revert-batches/{batchId}/undo","href":"/platform-api/time-machine/undo-a-revert-batch"},{"title":"List the fills a revert voided on an account","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/revert-batches/{batchId}/accounts/{accountId}/voided-fills","href":"/platform-api/time-machine/list-the-fills-a-revert-voided-on-an-account"}]},{"group":"Mass credit","pages":[{"title":"List balance adjustment batches","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/balance-adjustments","href":"/platform-api/mass-credit/list-balance-adjustment-batches"},{"title":"Credit back an incident window's losses","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/balance-adjustments","href":"/platform-api/mass-credit/credit-back-an-incident-windows-losses"},{"title":"List bulk jobs","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/jobs","href":"/platform-api/mass-credit/list-bulk-jobs"},{"title":"Preview a balance credit","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/balance-adjustments/preview","href":"/platform-api/mass-credit/preview-a-balance-credit"},{"title":"Preview a mass credit","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/balance-adjustments/previews","href":"/platform-api/mass-credit/preview-a-mass-credit"},{"title":"List mass credit templates","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/balance-adjustments/templates","href":"/platform-api/mass-credit/list-mass-credit-templates"},{"title":"Create a mass credit template","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/balance-adjustments/templates","href":"/platform-api/mass-credit/create-a-mass-credit-template"},{"title":"Get a balance adjustment batch","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/balance-adjustments/{batchId}","href":"/platform-api/mass-credit/get-a-balance-adjustment-batch"},{"title":"Get a bulk job","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/jobs/{jobId}","href":"/platform-api/mass-credit/get-a-bulk-job"},{"title":"Delete a mass credit template","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json delete /v1/organization/balance-adjustments/templates/{templateId}","href":"/platform-api/mass-credit/delete-a-mass-credit-template"},{"title":"Update a mass credit template","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json patch /v1/organization/balance-adjustments/templates/{templateId}","href":"/platform-api/mass-credit/update-a-mass-credit-template"},{"title":"Retry a balance adjustment batch","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/balance-adjustments/{batchId}/retry","href":"/platform-api/mass-credit/retry-a-balance-adjustment-batch"},{"title":"Reverse a balance credit","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/balance-adjustments/{batchId}/reverse","href":"/platform-api/mass-credit/reverse-a-balance-credit"},{"title":"Cancel a bulk job","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/jobs/{jobId}/cancel","href":"/platform-api/mass-credit/cancel-a-bulk-job"},{"title":"Export a bulk job's items as CSV","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/jobs/{jobId}/export","href":"/platform-api/mass-credit/export-a-bulk-jobs-items-as-csv"},{"title":"List a bulk job's items","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/jobs/{jobId}/items","href":"/platform-api/mass-credit/list-a-bulk-jobs-items"},{"title":"Pause a bulk job","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/jobs/{jobId}/pause","href":"/platform-api/mass-credit/pause-a-bulk-job"},{"title":"Resume a bulk job","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/jobs/{jobId}/resume","href":"/platform-api/mass-credit/resume-a-bulk-job"},{"title":"Retry a bulk job's failed items","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/jobs/{jobId}/retry","href":"/platform-api/mass-credit/retry-a-bulk-jobs-failed-items"},{"title":"Reverse a mass credit","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/balance-adjustments/jobs/{jobId}/reverse","href":"/platform-api/mass-credit/reverse-a-mass-credit"},{"title":"Confirm a mass credit","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/balance-adjustments/previews/{jobId}/confirm","href":"/platform-api/mass-credit/confirm-a-mass-credit"},{"title":"Add accounts to a draft preview","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/balance-adjustments/previews/{jobId}/inputs","href":"/platform-api/mass-credit/add-accounts-to-a-draft-preview"},{"title":"Start a draft preview","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/balance-adjustments/previews/{jobId}/start","href":"/platform-api/mass-credit/start-a-draft-preview"}]},{"group":"Webhooks","pages":[{"title":"View webhook delivery history","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/webhook-deliveries","href":"/platform-api/webhooks/view-webhook-delivery-history"},{"title":"List all webhooks","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/webhooks","href":"/platform-api/webhooks/list-all-webhooks"},{"title":"Register a webhook endpoint","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/webhooks","href":"/platform-api/webhooks/register-a-webhook-endpoint"},{"title":"Get daily webhook delivery activity","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/webhook-deliveries/activity","href":"/platform-api/webhooks/get-daily-webhook-delivery-activity"},{"title":"Inspect a webhook event and all delivery attempts","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/webhook-deliveries/{deliveryId}","href":"/platform-api/webhooks/inspect-a-webhook-event-and-all-delivery-attempts"},{"title":"Get webhook details","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/webhooks/{webhookId}","href":"/platform-api/webhooks/get-webhook-details"},{"title":"Update a webhook","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json put /v1/organization/webhooks/{webhookId}","href":"/platform-api/webhooks/update-a-webhook"},{"title":"Delete a webhook","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json delete /v1/organization/webhooks/{webhookId}","href":"/platform-api/webhooks/delete-a-webhook"},{"title":"Redeliver a webhook delivery","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/webhook-deliveries/{deliveryId}/redeliver","href":"/platform-api/webhooks/redeliver-a-webhook-delivery"},{"title":"Get webhook endpoint delivery and latency metrics","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/webhooks/{webhookId}/metrics","href":"/platform-api/webhooks/get-webhook-endpoint-delivery-and-latency-metrics"},{"title":"Rotate signing secret","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/webhooks/{webhookId}/rotate-secret","href":"/platform-api/webhooks/rotate-signing-secret"},{"title":"Simulate any event type (QA fixture)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/webhooks/{webhookId}/simulate","href":"/platform-api/webhooks/simulate-any-event-type-qa-fixture"},{"title":"Send a test event","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/webhooks/{webhookId}/test","href":"/platform-api/webhooks/send-a-test-event"}]},{"group":"Events","pages":[{"title":"List all organization events","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/events","href":"/platform-api/events/list-all-organization-events"},{"title":"Inspect one event and all its webhook deliveries","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/events/{eventId}","href":"/platform-api/events/inspect-one-event-and-all-its-webhook-deliveries"}]},{"group":"Real-time streams","pages":[{"title":"Real-time event stream (WebSocket)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/events/stream","href":"/platform-api/real-time-streams/real-time-event-stream-websocket"},{"title":"Create a trading stream token","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/stream-token","href":"/platform-api/real-time-streams/create-a-trading-stream-token"}]},{"group":"Reconciliation","pages":[{"title":"Get account balances (bulk, reconciliation-friendly)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/balances","href":"/platform-api/reconciliation/get-account-balances-bulk-reconciliation-friendly"},{"title":"Reconcile a trading day in one call","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/reconciliation","href":"/platform-api/reconciliation/reconcile-a-trading-day-in-one-call"},{"title":"Get end-of-day account snapshots","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/snapshots/accounts","href":"/platform-api/reconciliation/get-end-of-day-account-snapshots"},{"title":"Get fills for a trading day","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/snapshots/fills","href":"/platform-api/reconciliation/get-fills-for-a-trading-day"}]},{"group":"Analytics","pages":[{"title":"Get organization analytics","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/analytics","href":"/platform-api/analytics/get-organization-analytics"},{"title":"Get hourly activity by weekday","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/analytics/hourly","href":"/platform-api/analytics/get-hourly-activity-by-weekday"},{"title":"Get revenue breakdown","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/analytics/revenue","href":"/platform-api/analytics/get-revenue-breakdown"},{"title":"Get top traders over time","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/analytics/top-traders","href":"/platform-api/analytics/get-top-traders-over-time"}]},{"group":"Risk","pages":[{"title":"Get your alert limits","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/alert-limits","href":"/platform-api/risk/get-your-alert-limits"},{"title":"Set your alert limits","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json put /v1/organization/risk/alert-limits","href":"/platform-api/risk/set-your-alert-limits"},{"title":"List alerts raised by your limits","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/alerts","href":"/platform-api/risk/list-alerts-raised-by-your-limits"},{"title":"Get trader behavior by plan","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/behavior","href":"/platform-api/risk/get-trader-behavior-by-plan"},{"title":"Get plan performance by purchase month","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/cohorts","href":"/platform-api/risk/get-plan-performance-by-purchase-month"},{"title":"Read exposure and concentration","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/exposure","href":"/platform-api/risk/read-exposure-and-concentration"},{"title":"List exposure limits","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/exposure-limits","href":"/platform-api/risk/list-exposure-limits"},{"title":"Set exposure limits","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json put /v1/organization/risk/exposure-limits","href":"/platform-api/risk/set-exposure-limits"},{"title":"Read the risk flags of accounts","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/flags","href":"/platform-api/risk/read-the-risk-flags-of-accounts"},{"title":"List flagged traders","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/inbox","href":"/platform-api/risk/list-flagged-traders"},{"title":"List link clearances","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/link-clearances","href":"/platform-api/risk/list-link-clearances"},{"title":"Clear two traders to share a device or address","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/risk/link-clearances","href":"/platform-api/risk/clear-two-traders-to-share-a-device-or-address"},{"title":"Get traders linked by a shared device or IP address","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/linked-traders","href":"/platform-api/risk/get-traders-linked-by-a-shared-device-or-ip-address"},{"title":"List news windows","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/news-windows","href":"/platform-api/risk/list-news-windows"},{"title":"Add or update news windows","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json put /v1/organization/risk/news-windows","href":"/platform-api/risk/add-or-update-news-windows"},{"title":"Get a payout forecast for the next 7 and 30 days","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/payout-forecast","href":"/platform-api/risk/get-a-payout-forecast-for-the-next-7-and-30-days"},{"title":"Get per-plan unit economics and sustainability flags","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/plan-economics","href":"/platform-api/risk/get-per-plan-unit-economics-and-sustainability-flags"},{"title":"Get monthly firm P\u0026L (revenue vs payouts vs platform costs)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/pnl","href":"/platform-api/risk/get-monthly-firm-p\u0026l-revenue-vs-payouts-vs-platform-costs"},{"title":"List daily risk reports","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/reports","href":"/platform-api/risk/list-daily-risk-reports"},{"title":"Get the summary email settings","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/summary-email","href":"/platform-api/risk/get-the-summary-email-settings"},{"title":"Set the summary email","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json put /v1/organization/risk/summary-email","href":"/platform-api/risk/set-the-summary-email"},{"title":"List today's provisional risk pairs","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/today","href":"/platform-api/risk/list-todays-provisional-risk-pairs"},{"title":"Detect self-hedging, hedging and copy trading","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/trading-patterns","href":"/platform-api/risk/detect-self-hedging-hedging-and-copy-trading"},{"title":"Read the risk money summary","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/value","href":"/platform-api/risk/read-the-risk-money-summary"},{"title":"Read one risk finding with its proof","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/findings/{findingId}","href":"/platform-api/risk/read-one-risk-finding-with-its-proof"},{"title":"Count flagged traders","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/inbox/count","href":"/platform-api/risk/count-flagged-traders"},{"title":"Set the review state of a flagged trader","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json put /v1/organization/risk/inbox/{traderId}","href":"/platform-api/risk/set-the-review-state-of-a-flagged-trader"},{"title":"Revoke a link clearance","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json delete /v1/organization/risk/link-clearances/{clearanceId}","href":"/platform-api/risk/revoke-a-link-clearance"},{"title":"Read a risk match export","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/match-exports/{exportId}","href":"/platform-api/risk/read-a-risk-match-export"},{"title":"Delete a news window","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json delete /v1/organization/risk/news-windows/{windowId}","href":"/platform-api/risk/delete-a-news-window"},{"title":"List stored trading patterns","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/patterns/stored","href":"/platform-api/risk/list-stored-trading-patterns"},{"title":"Read the daily risk report of a trading day","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/reports/{tradingDay}","href":"/platform-api/risk/read-the-daily-risk-report-of-a-trading-day"},{"title":"List every risk match of a trading day","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/reports/{tradingDay}/matches","href":"/platform-api/risk/list-every-risk-match-of-a-trading-day"},{"title":"List the decisions on a trader","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/traders/{traderId}/decisions","href":"/platform-api/risk/list-the-decisions-on-a-trader"},{"title":"Record a decision on a flagged trader","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/risk/traders/{traderId}/decisions","href":"/platform-api/risk/record-a-decision-on-a-flagged-trader"},{"title":"Read one trader's risk findings with their proof","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/traders/{traderId}/findings","href":"/platform-api/risk/read-one-traders-risk-findings-with-their-proof"},{"title":"Rebuild the full risk match list of a trading day","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/risk/reports/{tradingDay}/matches/export","href":"/platform-api/risk/rebuild-the-full-risk-match-list-of-a-trading-day"}]},{"group":"Trader insights","pages":[{"title":"Read trader sentiment over time","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/insights/sentiment","href":"/platform-api/trader-insights/read-trader-sentiment-over-time"},{"title":"List your top traders by realized performance","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/insights/top-traders","href":"/platform-api/trader-insights/list-your-top-traders-by-realized-performance"},{"title":"List the traders you follow","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/insights/watchlist","href":"/platform-api/trader-insights/list-the-traders-you-follow"},{"title":"Get live positioning across all accounts","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/positioning","href":"/platform-api/trader-insights/get-live-positioning-across-all-accounts"},{"title":"List the entries and exits of the traders you follow","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/insights/watchlist/activity","href":"/platform-api/trader-insights/list-the-entries-and-exits-of-the-traders-you-follow"},{"title":"Follow a trader","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json put /v1/organization/insights/watchlist/{traderId}","href":"/platform-api/trader-insights/follow-a-trader"},{"title":"Stop following a trader","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json delete /v1/organization/insights/watchlist/{traderId}","href":"/platform-api/trader-insights/stop-following-a-trader"},{"title":"Get long vs short positioning over time","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/positioning/history","href":"/platform-api/trader-insights/get-long-vs-short-positioning-over-time"},{"title":"Get live exposure by product and trader","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/positioning/live","href":"/platform-api/trader-insights/get-live-exposure-by-product-and-trader"}]},{"group":"Billing and invoices","pages":[{"title":"Get daily billing activity","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/billing/activity","href":"/platform-api/billing-and-invoices/get-daily-billing-activity"},{"title":"Get credits","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/billing/credits","href":"/platform-api/billing-and-invoices/get-credits"},{"title":"List billing cycles","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/billing/cycles","href":"/platform-api/billing-and-invoices/list-billing-cycles"},{"title":"Get your billing details","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/billing/details","href":"/platform-api/billing-and-invoices/get-your-billing-details"},{"title":"Update your billing details","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json put /v1/organization/billing/details","href":"/platform-api/billing-and-invoices/update-your-billing-details"},{"title":"List all billing events","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/billing/events","href":"/platform-api/billing-and-invoices/list-all-billing-events"},{"title":"Project next month's bill from the current state","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/billing/forecast","href":"/platform-api/billing-and-invoices/project-next-months-bill-from-the-current-state"},{"title":"List invoices","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/billing/invoices","href":"/platform-api/billing-and-invoices/list-invoices"},{"title":"Get all-months billing aggregates","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/billing/monthly","href":"/platform-api/billing-and-invoices/get-all-months-billing-aggregates"},{"title":"Get monthly billing summary","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/billing/summary","href":"/platform-api/billing-and-invoices/get-monthly-billing-summary"},{"title":"Get this month so far","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/billing/usage","href":"/platform-api/billing-and-invoices/get-this-month-so-far"},{"title":"Get an invoice","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/billing/invoices/{invoiceId}","href":"/platform-api/billing-and-invoices/get-an-invoice"},{"title":"Export a month's line items as CSV","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/billing/line-items/export","href":"/platform-api/billing-and-invoices/export-a-months-line-items-as-csv"},{"title":"Get events for a billing cycle","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/billing/cycles/{cycleId}/events","href":"/platform-api/billing-and-invoices/get-events-for-a-billing-cycle"},{"title":"Get bank transfer instructions","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/billing/invoices/{invoiceId}/payment-instructions","href":"/platform-api/billing-and-invoices/get-bank-transfer-instructions"},{"title":"Download an invoice PDF","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/billing/invoices/{invoiceId}/pdf","href":"/platform-api/billing-and-invoices/download-an-invoice-pdf"}]},{"group":"Team and roles","pages":[{"title":"List roles (system presets + your custom roles)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/roles","href":"/platform-api/team-and-roles/list-roles-system-presets-+-your-custom-roles"},{"title":"Get team members for your organization","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/team","href":"/platform-api/team-and-roles/get-team-members-for-your-organization"},{"title":"List pending team invitations","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/team/invitations","href":"/platform-api/team-and-roles/list-pending-team-invitations"}]},{"group":"API keys","pages":[{"title":"List API keys","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/api-keys","href":"/platform-api/api-keys/list-api-keys"},{"title":"List AI apps connected with your API keys","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/api-keys/connections","href":"/platform-api/api-keys/list-ai-apps-connected-with-your-api-keys"}]},{"group":"Logs and health","pages":[{"title":"List API request logs","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/api-logs","href":"/platform-api/logs-and-health/list-api-request-logs"},{"title":"Get organization audit log","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/audit-log","href":"/platform-api/logs-and-health/get-organization-audit-log"},{"title":"Get integration health (alerts, errors, insights)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/health","href":"/platform-api/logs-and-health/get-integration-health-alerts-errors-insights"},{"title":"Look up an idempotency key","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/idempotency-keys","href":"/platform-api/logs-and-health/look-up-an-idempotency-key"},{"title":"List organization audit events","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/audit-log/events","href":"/platform-api/logs-and-health/list-organization-audit-events"},{"title":"Release a stuck idempotency key","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/idempotency-keys/release","href":"/platform-api/logs-and-health/release-a-stuck-idempotency-key"}]},{"group":"Organization profile","pages":[{"title":"Get your organization profile","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/profile","href":"/platform-api/organization-profile/get-your-organization-profile"},{"title":"Update your organization profile","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json put /v1/organization/profile","href":"/platform-api/organization-profile/update-your-organization-profile"},{"title":"Upload organization logo","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/profile/logo","href":"/platform-api/organization-profile/upload-organization-logo"},{"title":"Delete organization logo","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json delete /v1/organization/profile/logo","href":"/platform-api/organization-profile/delete-organization-logo"}]},{"group":"Support","pages":[{"title":"List your support tickets","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/support/tickets","href":"/platform-api/support/list-your-support-tickets"},{"title":"Create a support ticket","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/support/tickets","href":"/platform-api/support/create-a-support-ticket"},{"title":"Get signed upload URLs for ticket attachments","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/support/uploads","href":"/platform-api/support/get-signed-upload-urls-for-ticket-attachments"},{"title":"Get a support ticket with its reply thread","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/support/tickets/{ticketId}","href":"/platform-api/support/get-a-support-ticket-with-its-reply-thread"},{"title":"Reply on a support ticket","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/support/tickets/{ticketId}/comments","href":"/platform-api/support/reply-on-a-support-ticket"}]},{"group":"Partner access","pages":[{"title":"Get order history (keyset-paginated)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/user/trading/orders","href":"/platform-api/partner-access/get-order-history-keyset-paginated"},{"title":"Get completed round-trip trades (server-derived)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/user/trading/trades","href":"/platform-api/partner-access/get-completed-round-trip-trades-server-derived"}]}]},{"group":"Trade API","pages":[{"group":"Account","pages":[{"title":"Get current trading account with equity and P\u0026L","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/account","href":"/trade-api/account/get-current-trading-account-with-equity-and-p\u0026l"},{"title":"Get account lockout status","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/account/lockout","href":"/trade-api/account/get-account-lockout-status"},{"title":"Create or update account lockout","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/account/lockout","href":"/trade-api/account/create-or-update-account-lockout"},{"title":"Remove account lockout","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json delete /trade/account/lockout","href":"/trade-api/account/remove-account-lockout"},{"title":"Set or clear a trading account's display nickname.","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/account/nickname","href":"/trade-api/account/set-or-clear-a-trading-accounts-display-nickname"},{"title":"Get all trading accounts for the authenticated user","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/accounts","href":"/trade-api/account/get-all-trading-accounts-for-the-authenticated-user"},{"title":"Create a personal API key session","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/api-keys/session","href":"/trade-api/account/create-a-personal-api-key-session"},{"title":"List the trader's API keys","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/partner/keys","href":"/trade-api/account/list-the-traders-api-keys"},{"title":"Generate a trader API key for third-party access","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/partner/keys","href":"/trade-api/account/generate-a-trader-api-key-for-third-party-access"},{"title":"Revoke one of the trader's API keys","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json delete /trade/partner/keys/{key_id}","href":"/trade-api/account/revoke-one-of-the-traders-api-keys"},{"title":"Create a partner session","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/partner/session","href":"/trade-api/account/create-a-partner-session"}]},{"group":"Risk","pages":[{"title":"Read the trader's personal risk settings for an account.","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/account/risk-settings","href":"/trade-api/risk/read-the-traders-personal-risk-settings-for-an-account"},{"title":"Update personal risk settings.","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/account/risk-settings","href":"/trade-api/risk/update-personal-risk-settings"}]},{"group":"Accounts","pages":[{"title":"Consistency status for one of the caller's accounts","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/accounts/{account_id}/consistency","href":"/trade-api/accounts/consistency-status-for-one-of-the-callers-accounts"}]},{"group":"Positions","pages":[{"title":"Close all open positions for an account","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/close-all","href":"/trade-api/positions/close-all-open-positions-for-an-account"},{"title":"Flatten account: close positions and cancel orders","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/flatten","href":"/trade-api/positions/flatten-account:-close-positions-and-cancel-orders"},{"title":"Add margin to an isolated perpetual position, or remove some.","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/perp/isolated-margin","href":"/trade-api/positions/add-margin-to-an-isolated-perpetual-position-or-remove-some"},{"title":"Read the account's perpetual margin settings and position margins.","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/perp/margin","href":"/trade-api/positions/read-the-accounts-perpetual-margin-settings-and-position-margins"},{"title":"Set a perpetual's margin mode and/or leverage.","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/perp/margin","href":"/trade-api/positions/set-a-perpetuals-margin-mode-andor-leverage"},{"title":"Get perpetual mark prices","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/perp/mark","href":"/trade-api/positions/get-perpetual-mark-prices"},{"title":"Close a specific position by contract","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/position/close","href":"/trade-api/positions/close-a-specific-position-by-contract"},{"title":"Reverse a position (close + open opposite side)","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/position/reverse","href":"/trade-api/positions/reverse-a-position-close-+-open-opposite-side"},{"title":"Set TP/SL at the position level for one (account, contract) pair.","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/position/set-bracket","href":"/trade-api/positions/set-tpsl-at-the-position-level-for-one-account-contract-pair"},{"title":"Get open positions with real-time P\u0026L","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/positions","href":"/trade-api/positions/get-open-positions-with-real-time-p\u0026l"}]},{"group":"Orders","pages":[{"title":"Get command processing status by id","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/commands/{command_id}","href":"/trade-api/orders/get-command-processing-status-by-id"},{"title":"Submit a market, limit, or stop order","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/order","href":"/trade-api/orders/submit-a-market-limit-or-stop-order"},{"title":"Attach TP/SL bracket to an existing order","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/order/attach-bracket","href":"/trade-api/orders/attach-tpsl-bracket-to-an-existing-order"},{"title":"Cancel a pending order","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/order/cancel","href":"/trade-api/orders/cancel-a-pending-order"},{"title":"Detach TP/SL bracket leg from an order","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/order/detach-bracket","href":"/trade-api/orders/detach-tpsl-bracket-leg-from-an-order"},{"title":"Link a standalone order into the position's OCO group","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/order/link-oco","href":"/trade-api/orders/link-a-standalone-order-into-the-positions-oco-group"},{"title":"Modify price or quantity of a pending order","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/order/modify","href":"/trade-api/orders/modify-price-or-quantity-of-a-pending-order"},{"title":"Get all orders (filled, pending, cancelled)","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/orders","href":"/trade-api/orders/get-all-orders-filled-pending-cancelled"},{"title":"Cancel all pending orders for an account (keeps live position protection)","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/orders/cancel-all","href":"/trade-api/orders/cancel-all-pending-orders-for-an-account-keeps-live-position-protection"},{"title":"Get order history (append-only lifecycle events)","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/orders/history","href":"/trade-api/orders/get-order-history-append-only-lifecycle-events"},{"title":"Get active working orders","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/orders/pending","href":"/trade-api/orders/get-active-working-orders"},{"title":"Get trade execution history","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/trades","href":"/trade-api/orders/get-trade-execution-history"}]},{"group":"Copy Trading","pages":[{"title":"Get copy trading configuration","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/copy/config","href":"/trade-api/copy-trading/get-copy-trading-configuration"},{"title":"Create or update a copy trading config","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/copy/config","href":"/trade-api/copy-trading/create-or-update-a-copy-trading-config"},{"title":"Delete a copy trading config","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json delete /trade/copy/config","href":"/trade-api/copy-trading/delete-a-copy-trading-config"},{"title":"Toggle copy config active state","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/copy/config/active","href":"/trade-api/copy-trading/toggle-copy-config-active-state"},{"title":"Delete all copy trading configs","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json delete /trade/copy/config/all","href":"/trade-api/copy-trading/delete-all-copy-trading-configs"},{"title":"Bulk update copy trading group followers","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/copy/group","href":"/trade-api/copy-trading/bulk-update-copy-trading-group-followers"},{"title":"Get copy trading status and positions","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/copy/status","href":"/trade-api/copy-trading/get-copy-trading-status-and-positions"}]},{"group":"WebSocket","pages":[{"title":"Real-time WebSocket for trading events","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/ws","href":"/trade-api/websocket/real-time-websocket-for-trading-events"}]}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Create a new trading rule - Hyperprop Platform API","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-DdEMm2kG.js","utils-BMo572L7.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C-4m9KAx.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DPLK2Oq9.js","snippetPresets-BKjfJMC9.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-BIYvYBgk.js","ApiExamples-DTsgtCEj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C8vmhyQM.js","shallow-r9w8LQGS.js","getApiPlaygroundDisplay-DjPI64HQ.js","CodeSnippet-C8Bvhl16.js","CodeSnippets-BtWUwcMy.js","getPastedJson-Dcm_3Pgl.js","icon-BXwrTpjc.js","MethodPill-CcjfVmmy.js","DuplicateIcon-BuKIbXAQ.js","createIcon-DaL9yXsO.js","DynamicMarkdown-Co5nikxh.js","SectionHeading-P4UNTsMZ.js","axios-vUo_bRtp.js","Markdown-CEfymfIH.js","clsx-Dq9TQuNi.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-D2J8knkn.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BgZ2ThuU.js"]}