Account
Create or update account lockout
Activates a lockout on the specified account. Any existing lockout for the account is replaced.
Supported modes:
hours— lock for N hours (requireshoursfield)trading_day— lock until end of current CME trading daytimed— lock for a preset duration:15m,30m,1h, orall_day(requirestimed_duration)session— lock until a market session ends:ny,london, orcustom(requiressession, optionallysession_start/session_end/timezone)trade_clock— position-aware lockout that blocks NEW ENTRIES (submit order, reverse position) while the account has open exposure. Managing the live trade stays fully available: set/modify TP and SL (position brackets, modifying bracket children), attach/link/detach exits, cancel, close, and flatten all work.
For all modes except trade_clock, activating a lockout immediately flattens the account (closes positions + cancels orders) — warn the trader before activating one of these modes while they hold open positions.
During ANY active lockout, risk-reducing actions stay available: cancel order(s), close position(s), and flatten always work. A lockout blocks new risk, never the exit from existing risk.
POST
/
trade
/
account
/
lockout
Create or update account lockout
curl --request POST \
--url https://api.hyperprop.com/trade/account/lockout \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"account_id": "550e8400-e29b-41d4-a716-446655440000",
"mode": "timed",
"timed_duration": "30m"
}
'import requests
url = "https://api.hyperprop.com/trade/account/lockout"
payload = {
"account_id": "550e8400-e29b-41d4-a716-446655440000",
"mode": "timed",
"timed_duration": "30m"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
account_id: '550e8400-e29b-41d4-a716-446655440000',
mode: 'timed',
timed_duration: '30m'
})
};
fetch('https://api.hyperprop.com/trade/account/lockout', 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/account/lockout",
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([
'account_id' => '550e8400-e29b-41d4-a716-446655440000',
'mode' => 'timed',
'timed_duration' => '30m'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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/trade/account/lockout"
payload := strings.NewReader("{\n \"account_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"mode\": \"timed\",\n \"timed_duration\": \"30m\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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/trade/account/lockout")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"account_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"mode\": \"timed\",\n \"timed_duration\": \"30m\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/trade/account/lockout")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"account_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"mode\": \"timed\",\n \"timed_duration\": \"30m\"\n}"
response = http.request(request)
puts response.read_body{
"code": null,
"data": {
"account_id": "550e8400-e29b-41d4-a716-446655440000",
"active": true,
"cause": "trader_self_lock",
"ends_at": "2026-03-12T14:30:00Z",
"locked_by": "user",
"mode": "timed",
"reason": "Initiated by user",
"remaining_minutes": 30,
"starts_at": "2026-03-12T14:00:00Z",
"trade_clock_active": null
},
"error": null,
"success": true
}{
"code": "INVALID_LOCKOUT_MODE",
"data": null,
"error": "mode must be one of: hours, trading_day, timed, session, trade_clock",
"success": false
}{
"code": "UNAUTHORIZED",
"data": null,
"error": "Invalid or missing JWT token",
"success": false
}{
"code": "FORBIDDEN",
"data": null,
"error": "Account does not belong to you",
"success": false
}{
"code": "RATE_LIMITED",
"data": null,
"error": "Rate limit exceeded for order submissions. Max 10 requests per second per account. Retry after 100 ms.",
"rate_limit": {
"limit": 10,
"remaining": 0,
"reset": 1711800125,
"retry_after": 0.1
},
"success": false
}Authorizations
Body
application/json
Lockout creation request
Response
Lockout created and enforced
Lockout status response
⌘I
Create or update account lockout
curl --request POST \
--url https://api.hyperprop.com/trade/account/lockout \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"account_id": "550e8400-e29b-41d4-a716-446655440000",
"mode": "timed",
"timed_duration": "30m"
}
'import requests
url = "https://api.hyperprop.com/trade/account/lockout"
payload = {
"account_id": "550e8400-e29b-41d4-a716-446655440000",
"mode": "timed",
"timed_duration": "30m"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
account_id: '550e8400-e29b-41d4-a716-446655440000',
mode: 'timed',
timed_duration: '30m'
})
};
fetch('https://api.hyperprop.com/trade/account/lockout', 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/account/lockout",
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([
'account_id' => '550e8400-e29b-41d4-a716-446655440000',
'mode' => 'timed',
'timed_duration' => '30m'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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/trade/account/lockout"
payload := strings.NewReader("{\n \"account_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"mode\": \"timed\",\n \"timed_duration\": \"30m\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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/trade/account/lockout")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"account_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"mode\": \"timed\",\n \"timed_duration\": \"30m\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/trade/account/lockout")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"account_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"mode\": \"timed\",\n \"timed_duration\": \"30m\"\n}"
response = http.request(request)
puts response.read_body{
"code": null,
"data": {
"account_id": "550e8400-e29b-41d4-a716-446655440000",
"active": true,
"cause": "trader_self_lock",
"ends_at": "2026-03-12T14:30:00Z",
"locked_by": "user",
"mode": "timed",
"reason": "Initiated by user",
"remaining_minutes": 30,
"starts_at": "2026-03-12T14:00:00Z",
"trade_clock_active": null
},
"error": null,
"success": true
}{
"code": "INVALID_LOCKOUT_MODE",
"data": null,
"error": "mode must be one of: hours, trading_day, timed, session, trade_clock",
"success": false
}{
"code": "UNAUTHORIZED",
"data": null,
"error": "Invalid or missing JWT token",
"success": false
}{
"code": "FORBIDDEN",
"data": null,
"error": "Account does not belong to you",
"success": false
}{
"code": "RATE_LIMITED",
"data": null,
"error": "Rate limit exceeded for order submissions. Max 10 requests per second per account. Retry after 100 ms.",
"rate_limit": {
"limit": 10,
"remaining": 0,
"reset": 1711800125,
"retry_after": 0.1
},
"success": false
}