Organization

Create admin lockout

Lock a trading account so the trader cannot open new risk. Risk-reducing actions (closing positions, cancelling orders, flattening) always remain available to the trader — a lockout can never trap someone in a losing position.

How it works:

Any existing active lockout on the account is cancelled first
A new lockout is created with locked_by: admin
The running trade engine picks it up immediately (this endpoint pushes it; a periodic engine resync is the fallback within ~15 seconds)
For every mode except trade_clock, the account is flattened at creation: open positions are closed and working orders cancelled. The response reports positionsClosed and ordersCancelled.
If any exposure somehow appears on a locked account later (for example an in-flight order), the engine detects it on the next market tick and closes it automatically
The trader cannot remove admin lockouts — only an admin can unlock

Lockout modes:

Mode	Description
`admin`	Blocks new entries until `endsAt`; account is flattened at creation
`timed`	Time-based lock with specific start/end; account is flattened at creation
`session`	Locked for the current trading session; account is flattened at creation
`trade_clock`	Discipline lock — blocks new entries while the account holds exposure, does NOT flatten; closing/flattening stays available

For indefinite locks: Set endsAt to a far-future date like 2099-12-31T23:59:59Z.

POST

organization

lockouts

Create admin lockout

curl --request POST \
  --url https://api.hyperprop.com/platform/v1/organization/lockouts \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accountId": "<string>",
  "mode": "admin",
  "reason": "Risk review: unusual trading pattern detected",
  "endsAt": "2026-04-01T00:00:00Z"
}
'

import requests

url = "https://api.hyperprop.com/platform/v1/organization/lockouts"

payload = {
    "accountId": "<string>",
    "mode": "admin",
    "reason": "Risk review: unusual trading pattern detected",
    "endsAt": "2026-04-01T00:00:00Z"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    accountId: '<string>',
    mode: 'admin',
    reason: 'Risk review: unusual trading pattern detected',
    endsAt: '2026-04-01T00:00:00Z'
  })
};

fetch('https://api.hyperprop.com/platform/v1/organization/lockouts', 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/lockouts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'accountId' => '<string>',
    'mode' => 'admin',
    'reason' => 'Risk review: unusual trading pattern detected',
    'endsAt' => '2026-04-01T00:00:00Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.hyperprop.com/platform/v1/organization/lockouts"

	payload := strings.NewReader("{\n  \"accountId\": \"<string>\",\n  \"mode\": \"admin\",\n  \"reason\": \"Risk review: unusual trading pattern detected\",\n  \"endsAt\": \"2026-04-01T00:00:00Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.hyperprop.com/platform/v1/organization/lockouts")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"accountId\": \"<string>\",\n  \"mode\": \"admin\",\n  \"reason\": \"Risk review: unusual trading pattern detected\",\n  \"endsAt\": \"2026-04-01T00:00:00Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"accountId\": \"<string>\",\n  \"mode\": \"admin\",\n  \"reason\": \"Risk review: unusual trading pattern detected\",\n  \"endsAt\": \"2026-04-01T00:00:00Z\"\n}"

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

{
  "success": true,
  "message": "Lockout created successfully",
  "data": {
    "id": "b1c2d3e4-f5a6-7890-abcd-ef1234567890",
    "accountId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "userId": "f994bc02-343c-4026-8a57-afc085eca8d5",
    "mode": "admin",
    "reason": "Risk review: unusual trading pattern detected",
    "lockedBy": "admin",
    "startsAt": "2026-03-12T15:00:00.000Z",
    "endsAt": "2026-04-01T00:00:00.000Z",
    "createdAt": "2026-03-12T15:00:00.000Z",
    "positionsClosed": 1,
    "ordersCancelled": 2
  }
}

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

{
  "success": false,
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Access denied",
  "code": "FORBIDDEN"
}

{
  "statusCode": 404,
  "error": "Not Found",
  "message": "Account not found in your organization",
  "code": "ACCOUNT_NOT_FOUND"
}

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

Body

application/json

accountId

string

required

Account ID to lock

mode

enum<string>

required

Lockout mode

Available options:

admin,

timed,

session,

trade_clock

Example:

"admin"

reason

string

required

Reason shown to the trader

Minimum string length: 3

Example:

"Risk review: unusual trading pattern detected"

endsAt

string

required

When lockout expires. Use far-future date for indefinite locks.

Example:

"2026-04-01T00:00:00Z"

Response

Lockout created

success

boolean

Example:

true

message

string

Example:

"Lockout created successfully"

data

object

Show child attributes

Example:

{
  "id": "b1c2d3e4-f5a6-7890-abcd-ef1234567890",
  "accountId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "userId": "f994bc02-343c-4026-8a57-afc085eca8d5",
  "mode": "admin",
  "reason": "Risk review: unusual trading pattern detected",
  "lockedBy": "admin",
  "startsAt": "2026-03-12T15:00:00.000Z",
  "endsAt": "2026-04-01T00:00:00.000Z",
  "createdAt": "2026-03-12T15:00:00.000Z",
  "positionsClosed": 1,
  "ordersCancelled": 2
}

⌘I

Create admin lockout

curl --request POST \
  --url https://api.hyperprop.com/platform/v1/organization/lockouts \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accountId": "<string>",
  "mode": "admin",
  "reason": "Risk review: unusual trading pattern detected",
  "endsAt": "2026-04-01T00:00:00Z"
}
'

import requests

url = "https://api.hyperprop.com/platform/v1/organization/lockouts"

payload = {
    "accountId": "<string>",
    "mode": "admin",
    "reason": "Risk review: unusual trading pattern detected",
    "endsAt": "2026-04-01T00:00:00Z"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    accountId: '<string>',
    mode: 'admin',
    reason: 'Risk review: unusual trading pattern detected',
    endsAt: '2026-04-01T00:00:00Z'
  })
};

fetch('https://api.hyperprop.com/platform/v1/organization/lockouts', 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/lockouts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'accountId' => '<string>',
    'mode' => 'admin',
    'reason' => 'Risk review: unusual trading pattern detected',
    'endsAt' => '2026-04-01T00:00:00Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.hyperprop.com/platform/v1/organization/lockouts"

	payload := strings.NewReader("{\n  \"accountId\": \"<string>\",\n  \"mode\": \"admin\",\n  \"reason\": \"Risk review: unusual trading pattern detected\",\n  \"endsAt\": \"2026-04-01T00:00:00Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.hyperprop.com/platform/v1/organization/lockouts")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"accountId\": \"<string>\",\n  \"mode\": \"admin\",\n  \"reason\": \"Risk review: unusual trading pattern detected\",\n  \"endsAt\": \"2026-04-01T00:00:00Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"accountId\": \"<string>\",\n  \"mode\": \"admin\",\n  \"reason\": \"Risk review: unusual trading pattern detected\",\n  \"endsAt\": \"2026-04-01T00:00:00Z\"\n}"

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

{
  "success": true,
  "message": "Lockout created successfully",
  "data": {
    "id": "b1c2d3e4-f5a6-7890-abcd-ef1234567890",
    "accountId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "userId": "f994bc02-343c-4026-8a57-afc085eca8d5",
    "mode": "admin",
    "reason": "Risk review: unusual trading pattern detected",
    "lockedBy": "admin",
    "startsAt": "2026-03-12T15:00:00.000Z",
    "endsAt": "2026-04-01T00:00:00.000Z",
    "createdAt": "2026-03-12T15:00:00.000Z",
    "positionsClosed": 1,
    "ordersCancelled": 2
  }
}

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

{
  "success": false,
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Access denied",
  "code": "FORBIDDEN"
}

{
  "statusCode": 404,
  "error": "Not Found",
  "message": "Account not found in your organization",
  "code": "ACCOUNT_NOT_FOUND"
}

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

Platform API

Trade API

Market Data API

Create admin lockout

Authorizations

Body

Response