Accounts

Consistency status for one of the caller's accounts

Full consistency picture for the account: the daily cap, best day, profitable-day counts, and plain-language reasons whenever the rule is currently blocking an evaluation pass (or a funded payout). Returns consistency: null when the account’s rule has no consistency percentage configured.

Response

{
"success": true,
"data": {
"account_id": "550e8400-e29b-41d4-a716-446655440000",
"payout_count": 1,
"completion_pending_reason": "Profit target reached — Best day $1,720.00 reaches the $1,700.00 daily cap (50% of $3,200.00 + $100.00 buffer). Spread gains across more days to dilute it.",
"consistency": {
"enforced": true,
"gate": "evaluation_pass",
"eligible": false,
"consistency_pct": 50,
"base_mode": "max_target_or_pnl",
"base_amount": 3200.0,
"daily_cap": 1700.0,
"buffer": 100.0,
"best_day_pnl": 1720.0,
"best_day": "2026-07-10",
"profitable_days": 2,
"min_profitable_days": 2,
"reference_pnl": 3200.0,
"blocking_days": [{ "trading_day": "2026-07-10", "net_pnl": 1720.0 }],
"reasons": ["Best day $1,720.00 reaches the $1,700.00 daily cap (50% of $3,200.00 + $100.00 buffer). Spread gains across more days to dilute it."]
}
}
}

GET

trade

accounts

{account_id}

consistency

Consistency status for one of the caller's accounts

curl --request GET \
  --url https://api.hyperprop.com/trade/accounts/{account_id}/consistency

const options = {method: 'GET'};

fetch('https://api.hyperprop.com/trade/accounts/{account_id}/consistency', 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/trade/accounts/{account_id}/consistency",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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/trade/accounts/{account_id}/consistency"

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

	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/trade/accounts/{account_id}/consistency")

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

request = Net::HTTP::Get.new(url)

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

{
  "code": null,
  "data": {
    "base_amount": 3000,
    "best_day_profit": 1875,
    "cap_amount": 1500,
    "consistency_pct": 50,
    "eligible": false,
    "enforced": true,
    "gate": "evaluation_pass",
    "reason": "Best day $1,875.00 exceeds the $1,500.00 cap (50% of $3,000.00 total profit)"
  },
  "error": null,
  "success": true
}

{
  "code": "ERROR_CODE",
  "data": null,
  "error": "Error message describing what went wrong",
  "success": false
}

{
  "code": "ERROR_CODE",
  "data": null,
  "error": "Error message describing what went wrong",
  "success": false
}

Path Parameters

account_id

string<uuid>

required

Trading account ID

Response

Consistency status for the account

Full consistency picture for an account, built for partner APIs and the terminal UI. Carries the numbers (cap, best day, day counts) plus plain-language reasons so "why am I blocked?" is always answerable.

base_amount

number<double>

required

Dollar amount the percentage was applied to.

Example:

3200

base_mode

string

required

Resolved base mode (max_target_or_pnl, total_pnl, profit_target, cycle_profit).

Example:

"max_target_or_pnl"

best_day_pnl

number<double>

required

Best (highest net PnL) day seen in the window.

Example:

1720

blocking_days

object[]

required

Every day currently at/over the cap (what must dilute before passing).

Show child attributes

buffer

number<double>

required

Buffer portion of the cap (tolerance + leniency).

Example:

100

consistency_pct

integer<int32>

required

Consistency percentage from the rule.

Example:

50

daily_cap

number<double>

required

The cap: any single day's net PnL must stay BELOW this (inclusive fail).

Example:

1700

eligible

boolean

required

True when the consistency rule is currently satisfied.

Example:

false

enforced

boolean

required

Whether the rule actually gates anything (rule.consistency_enforced). When false the status is informational only.

Example:

true

gate

string

required

Which gate this status feeds: evaluation_pass or funded_payout.

Example:

"evaluation_pass"

min_profitable_days

integer<int32>

required

Required profitable days (0 = no requirement, e.g. funded gate).

Example:

2

profitable_days

integer<int32>

required

Days with net PnL >= the profitable-day threshold.

Example:

1

reasons

string[]

required

Plain-language reasons the gate is blocking. Empty when eligible.

Example:

[
  "Best day $1,720.00 reaches the $1,700.00 daily cap (50% of $3,200.00 + $100.00 buffer). Spread gains across more days to dilute it."
]

reference_pnl

number<double>

required

Eval: total PnL. Funded: profit in the current payout cycle.

Example:

3200

best_day

string | null

Trading day of the best day, when any day exists.

⌘I

Consistency status for one of the caller's accounts

curl --request GET \
  --url https://api.hyperprop.com/trade/accounts/{account_id}/consistency

const options = {method: 'GET'};

fetch('https://api.hyperprop.com/trade/accounts/{account_id}/consistency', 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/trade/accounts/{account_id}/consistency",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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/trade/accounts/{account_id}/consistency"

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

	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/trade/accounts/{account_id}/consistency")

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

request = Net::HTTP::Get.new(url)

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

{
  "code": null,
  "data": {
    "base_amount": 3000,
    "best_day_profit": 1875,
    "cap_amount": 1500,
    "consistency_pct": 50,
    "eligible": false,
    "enforced": true,
    "gate": "evaluation_pass",
    "reason": "Best day $1,875.00 exceeds the $1,500.00 cap (50% of $3,000.00 total profit)"
  },
  "error": null,
  "success": true
}

{
  "code": "ERROR_CODE",
  "data": null,
  "error": "Error message describing what went wrong",
  "success": false
}

{
  "code": "ERROR_CODE",
  "data": null,
  "error": "Error message describing what went wrong",
  "success": false
}

Platform API

Trade API

Market Data API

Consistency status for one of the caller's accounts

Response

Path Parameters

Response