Organization

Get trading rules for your organization

Retrieve all trading rules configured for your organization.

What are trading rules? Trading 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.

Rule parameters explained:

Parameter	Description
`profitTarget`	Amount trader must profit to pass (e.g., $10,000)
`dailyLoss`	Max loss allowed in a single day (e.g., $2,500)
`maxLoss`	Max total loss from starting balance (e.g., $5,000)
`dailyDrawdown`	Max daily drawdown from day’s high (e.g., $2,500)
`maxDrawdown`	Max drawdown from high water mark (e.g., $5,000)
`maxContracts`	Max position size in mini-equivalent contracts (e.g., 10)
`microConversionRatio`	How many micros count as 1 unit toward maxContracts (default 10)
`consistency`	Consistency rule percentage (0 = disabled)
`dailyProfit`	Max daily profit cap (0 = unlimited)
`maxProfit`	Max total profit cap (0 = unlimited)
`personalRiskPolicy`	Bounds on the risk controls traders set for themselves (see below)

Personal risk policy (personalRiskPolicy):

Traders can impose their own risk controls on an account — a personal daily loss limit (optionally trailing their session peak), a daily profit target, max trades per day/week, per-symbol contract limits, symbol blocks and automatic brackets. These are enforced by the trade engine in real time and can only ever make an account stricter than your rule set.

personalRiskPolicy lets you bound what a trader may choose:

{
  "personalRiskPolicy": {
    "dailyLossLimitMax": 1000,
    "dailyLossLimitDefault": 500,
    "requireDailyLossLimit": true,
    "maxTradesPerDayMax": 20,
    "requireAutoBracket": false,
    "lockedByFirm": false
  }
}

Every value is a ceiling: a trader may always pick something stricter.
A ceiling is an effective bound, not just form validation. If the trader leaves the field empty, your value applies (dailyLossLimitDefault when set, otherwise dailyLossLimitMax) — nobody escapes a bound by leaving a field blank.
requireDailyLossLimit also forces the limit to be armed: a trader cannot set the action to “do nothing”.
lockedByFirm: true makes the whole personal risk panel read-only; the trader’s own API calls are rejected with FIRM_LOCKED.
Omit the object entirely (or send null on update) to leave traders unconstrained. Nothing changes for existing rule sets.

Traders read and write their own settings through the trade API (GET/POST /trade/account/risk-settings); this policy is the only knob you need on your side.

Example rule sets:

Standard Challenge (beginner-friendly):

Profit target: $10,000 (10%)
Daily loss: $2,500 (2.5%)
Max drawdown: $5,000 (5%)

Aggressive Challenge (experienced traders):

Profit target: $8,000 (8%)
Daily loss: $4,000 (4%)
Max drawdown: $6,000 (6%)

Filtering by metadata:

# Find strict rule sets
GET /organization/trading-rules?metadata=strict:true

# Find rules by version
GET /organization/trading-rules?metadata=ruleVersion:2.1

# Find rules for specific markets
GET /organization/trading-rules?metadata=market:futures

Use cases:

Display rule details on your website
Validate rule IDs before creating accounts
Compare different rule configurations
Audit your risk parameters

GET

organization

trading-rules

Get trading rules for your organization

curl --request GET \
  --url https://api.hyperprop.com/platform/v1/organization/trading-rules \
  --header 'Authorization: <api-key>'

import requests

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

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hyperprop.com/platform/v1/organization/trading-rules",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

{
  "success": true,
  "data": {
    "organizationId": "a6fcc0ce-eb28-4f43-b256-96a3144b0d34",
    "organizationName": "FakePropFirm",
    "rules": [
      {
        "id": "6bec94a1-425b-47be-bb41-a80e3140e2e7",
        "name": "Standard Rules",
        "description": "Balanced evaluation rules with 8% profit target and 5% max trailing loss.",
        "profitTarget": 4000,
        "dailyProfit": 0,
        "maxProfit": 0,
        "dailyLoss": 1000,
        "maxLoss": 2500,
        "dailyDrawdown": 2,
        "maxDrawdown": 5,
        "drawdownType": "static",
        "consistency": 0,
        "maxContracts": 10,
        "microConversionRatio": 10,
        "metadata": {},
        "createdAt": "2025-12-30T12:03:09.385Z",
        "updatedAt": "2026-03-03T15:00:00.000Z"
      },
      {
        "id": "6cf3821e-0ad4-427f-85a5-c3d498aa342e",
        "name": "Aggressive Rules",
        "description": "Higher risk tolerance with 10% profit target and 6% max loss.",
        "profitTarget": 10000,
        "dailyProfit": 0,
        "maxProfit": 0,
        "dailyLoss": 3000,
        "maxLoss": 6000,
        "dailyDrawdown": 3,
        "maxDrawdown": 6,
        "drawdownType": "trailing",
        "consistency": 0,
        "maxContracts": 20,
        "microConversionRatio": 5,
        "metadata": {},
        "createdAt": "2026-02-18T21:19:56.853Z",
        "updatedAt": "2026-03-03T15:00:00.000Z"
      }
    ],
    "pagination": {
      "total": 4,
      "limit": 50,
      "offset": 0,
      "hasMore": false
    }
  }
}

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid or expired session"
}

{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "This endpoint is only available for organization users",
  "code": "NOT_ORGANIZATION_USER"
}

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

Authorizations

Authorization

string

header

required

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

Query Parameters

metadata

string

Filter by metadata key:value (e.g., "strict:true", "level:advanced")

limit

integer

default:50

Results per page (default: 50, max: 100)

Required range: 1 <= x <= 100

offset

integer

default:0

Pagination offset

Required range: x >= 0

cursor

string

Cursor for pagination. Pass the nextCursor value from the previous response to get the next page. When using cursor, do not send offset — it will be ignored.

How it works: The cursor is an opaque string that points to the last item you received. The server uses it to efficiently fetch the next set of results without scanning previous pages.

Backwards compatible: If you don't send a cursor, offset/limit pagination works as before.

Response

Success - Returns all trading rules

success

boolean

Example:

true

data

object

Show child attributes

Example:

{
  "organizationId": "a6fcc0ce-eb28-4f43-b256-96a3144b0d34",
  "organizationName": "FakePropFirm",
  "rules": [
    {
      "id": "6bec94a1-425b-47be-bb41-a80e3140e2e7",
      "name": "Standard Rules",
      "description": "Balanced evaluation rules with 8% profit target and 5% max trailing loss.",
      "profitTarget": 4000,
      "dailyProfit": 0,
      "maxProfit": 0,
      "dailyLoss": 1000,
      "maxLoss": 2500,
      "dailyDrawdown": 2,
      "maxDrawdown": 5,
      "drawdownType": "static",
      "consistency": 0,
      "maxContracts": 10,
      "microConversionRatio": 10,
      "metadata": {},
      "createdAt": "2025-12-30T12:03:09.385Z",
      "updatedAt": "2026-03-03T15:00:00.000Z"
    },
    {
      "id": "6cf3821e-0ad4-427f-85a5-c3d498aa342e",
      "name": "Aggressive Rules",
      "description": "Higher risk tolerance with 10% profit target and 6% max loss.",
      "profitTarget": 10000,
      "dailyProfit": 0,
      "maxProfit": 0,
      "dailyLoss": 3000,
      "maxLoss": 6000,
      "dailyDrawdown": 3,
      "maxDrawdown": 6,
      "drawdownType": "trailing",
      "consistency": 0,
      "maxContracts": 20,
      "microConversionRatio": 5,
      "metadata": {},
      "createdAt": "2026-02-18T21:19:56.853Z",
      "updatedAt": "2026-03-03T15:00:00.000Z"
    }
  ],
  "pagination": {
    "total": 4,
    "limit": 50,
    "offset": 0,
    "hasMore": false
  }
}

⌘I

Get trading rules for your organization

curl --request GET \
  --url https://api.hyperprop.com/platform/v1/organization/trading-rules \
  --header 'Authorization: <api-key>'

import requests

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

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hyperprop.com/platform/v1/organization/trading-rules",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

{
  "success": true,
  "data": {
    "organizationId": "a6fcc0ce-eb28-4f43-b256-96a3144b0d34",
    "organizationName": "FakePropFirm",
    "rules": [
      {
        "id": "6bec94a1-425b-47be-bb41-a80e3140e2e7",
        "name": "Standard Rules",
        "description": "Balanced evaluation rules with 8% profit target and 5% max trailing loss.",
        "profitTarget": 4000,
        "dailyProfit": 0,
        "maxProfit": 0,
        "dailyLoss": 1000,
        "maxLoss": 2500,
        "dailyDrawdown": 2,
        "maxDrawdown": 5,
        "drawdownType": "static",
        "consistency": 0,
        "maxContracts": 10,
        "microConversionRatio": 10,
        "metadata": {},
        "createdAt": "2025-12-30T12:03:09.385Z",
        "updatedAt": "2026-03-03T15:00:00.000Z"
      },
      {
        "id": "6cf3821e-0ad4-427f-85a5-c3d498aa342e",
        "name": "Aggressive Rules",
        "description": "Higher risk tolerance with 10% profit target and 6% max loss.",
        "profitTarget": 10000,
        "dailyProfit": 0,
        "maxProfit": 0,
        "dailyLoss": 3000,
        "maxLoss": 6000,
        "dailyDrawdown": 3,
        "maxDrawdown": 6,
        "drawdownType": "trailing",
        "consistency": 0,
        "maxContracts": 20,
        "microConversionRatio": 5,
        "metadata": {},
        "createdAt": "2026-02-18T21:19:56.853Z",
        "updatedAt": "2026-03-03T15:00:00.000Z"
      }
    ],
    "pagination": {
      "total": 4,
      "limit": 50,
      "offset": 0,
      "hasMore": false
    }
  }
}

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid or expired session"
}

{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "This endpoint is only available for organization users",
  "code": "NOT_ORGANIZATION_USER"
}

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

Platform API

Trade API

Market Data API

Get trading rules for your organization

Authorizations

Query Parameters

Response