Get a specific trading rule

curl --request GET \
  --url https://api.hyperprop.com/platform/v1/organization/trading-rules/{ruleId} \
  --header 'X-API-Key: <api-key>'

import requests

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

headers = {"X-API-Key": "<api-key>"}

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

print(response.text)

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

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hyperprop.com/platform/v1/organization/trading-rules/{ruleId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <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/{ruleId}"

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

	req.Header.Add("X-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.hyperprop.com/platform/v1/organization/trading-rules/{ruleId}")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

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

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

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

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

{
  "success": true,
  "data": {
    "id": "660e8400-e29b-41d4-a716-446655440000",
    "name": "Standard Challenge Rules",
    "description": "Balanced rules for most traders. 10% profit target, 5% max drawdown.",
    "profitTarget": 10000,
    "dailyProfit": 0,
    "maxProfit": 0,
    "dailyLoss": 2500,
    "maxLoss": 5000,
    "dailyDrawdown": 2500,
    "maxDrawdown": 5000,
    "drawdownType": "trailing",
    "drawdownDenomination": "percent",
    "drawdownTrailCeiling": null,
    "newsTradingAllowed": true,
    "microscalpingAllowed": true,
    "weekendHoldingAllowed": true,
    "overnightHoldingAllowed": true,
    "consistency": 50,
    "consistencyEnforced": true,
    "consistencyBase": "<string>",
    "consistencyTolerancePct": 123,
    "consistencyLeniency": 123,
    "consistencyMinDays": 123,
    "consistencyProfitableDayMin": 123,
    "maxPayouts": 123,
    "payoutMllLockOffset": 123,
    "maxContracts": 10,
    "microConversionRatio": 10,
    "personalRiskPolicy": {
      "dailyLossLimitMax": 1000,
      "dailyLossLimitDefault": 500,
      "requireDailyLossLimit": true,
      "maxTradesPerDayMax": 20
    },
    "scalingPlan": {
      "basis": "balance",
      "tiers": [
        {
          "profit": 0,
          "maxContracts": 1
        },
        {
          "profit": 1000,
          "maxContracts": 2
        },
        {
          "profit": 3000,
          "maxContracts": 5.5
        }
      ]
    },
    "metadata": {
      "ruleVersion": "2.1",
      "market": "futures",
      "weekendHoldingAllowed": false
    },
    "createdAt": "2025-01-15T10:00:00.000Z",
    "updatedAt": "2025-01-20T14:30:00.000Z"
  }
}

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

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

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

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