Organization

List all active lockouts

Returns all active lockouts across your organization.

Use cases:

Dashboard overview of all locked accounts
Audit which accounts are currently restricted
Review lockout reasons before bulk unlocking

locked_by values:

Value	Meaning	User can remove?
`admin`	Created by org admin	No
`user`	Self-imposed by trader	Only `trade_clock` when flat
`system`	Auto-lockout (DTD breach, etc.)	No

All lockouts can be removed by admin regardless of locked_by.

GET

organization

lockouts

List all active lockouts

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

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

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 => "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/lockouts"

	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/lockouts")

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",
    "lockouts": [
      {
        "id": "b1c2d3e4-f5a6-7890-abcd-ef1234567890",
        "accountId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
        "accountNumber": "ACC-7845KXPQ",
        "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"
      },
      {
        "id": "c2d3e4f5-a6b7-8901-bcde-f12345678901",
        "accountId": "8d0f7780-8536-51ef-b55c-f18gd2g01bf8",
        "accountNumber": "ACC-9921MZPL",
        "userId": "40e7760b-3768-4513-b8c3-8d12f0f1d1da",
        "mode": "trade_clock",
        "reason": "Initiated by user",
        "lockedBy": "user",
        "startsAt": "2026-03-12T14:00:00.000Z",
        "endsAt": "2026-03-12T16:00:00.000Z",
        "createdAt": "2026-03-12T14:00:00.000Z"
      }
    ],
    "pagination": {
      "total": 2,
      "limit": 50,
      "offset": 0,
      "hasMore": false,
      "nextCursor": null
    }
  }
}

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

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

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

Active lockouts retrieved

success

boolean

Example:

true

data

object

Show child attributes

Example:

{
  "organizationId": "a6fcc0ce-eb28-4f43-b256-96a3144b0d34",
  "organizationName": "FakePropFirm",
  "lockouts": [
    {
      "id": "b1c2d3e4-f5a6-7890-abcd-ef1234567890",
      "accountId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "accountNumber": "ACC-7845KXPQ",
      "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"
    },
    {
      "id": "c2d3e4f5-a6b7-8901-bcde-f12345678901",
      "accountId": "8d0f7780-8536-51ef-b55c-f18gd2g01bf8",
      "accountNumber": "ACC-9921MZPL",
      "userId": "40e7760b-3768-4513-b8c3-8d12f0f1d1da",
      "mode": "trade_clock",
      "reason": "Initiated by user",
      "lockedBy": "user",
      "startsAt": "2026-03-12T14:00:00.000Z",
      "endsAt": "2026-03-12T16:00:00.000Z",
      "createdAt": "2026-03-12T14:00:00.000Z"
    }
  ],
  "pagination": {
    "total": 2,
    "limit": 50,
    "offset": 0,
    "hasMore": false,
    "nextCursor": null
  }
}

⌘I

List all active lockouts

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

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

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 => "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/lockouts"

	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/lockouts")

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",
    "lockouts": [
      {
        "id": "b1c2d3e4-f5a6-7890-abcd-ef1234567890",
        "accountId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
        "accountNumber": "ACC-7845KXPQ",
        "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"
      },
      {
        "id": "c2d3e4f5-a6b7-8901-bcde-f12345678901",
        "accountId": "8d0f7780-8536-51ef-b55c-f18gd2g01bf8",
        "accountNumber": "ACC-9921MZPL",
        "userId": "40e7760b-3768-4513-b8c3-8d12f0f1d1da",
        "mode": "trade_clock",
        "reason": "Initiated by user",
        "lockedBy": "user",
        "startsAt": "2026-03-12T14:00:00.000Z",
        "endsAt": "2026-03-12T16:00:00.000Z",
        "createdAt": "2026-03-12T14:00:00.000Z"
      }
    ],
    "pagination": {
      "total": 2,
      "limit": 50,
      "offset": 0,
      "hasMore": false,
      "nextCursor": null
    }
  }
}

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

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

Platform API

Trade API

Market Data API

List all active lockouts

Authorizations

Query Parameters

Response