Trading accounts

Close all positions on an account

Closes every open position at market and cancels every working order on one account, immediately. The account keeps its status and is not locked out — the trader can trade again straight away; combine with POST /organization/lockouts if you also want to stop further trading.

The resulting orders carry reason Admin flatten: <who> — <your reason> (trigger admin_flatten), and an ACCOUNT_UPDATED event with the counts lands on the account’s event log.

Requires manage permission on traders. If the trading engine cannot be reached the call fails with 502 and nothing is closed.

curl -X POST "https://api.hyperprop.com/platform/v1/organization/trading-accounts/7c9e6679-7425-40de-944b-e07fc1f90ae7/flatten" \
  -H "X-API-Key: hp_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"reason": "Hedging review"}'

POST

organization

trading-accounts

{accountId}

flatten

Close all positions on an account

curl --request POST \
  --url https://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId}/flatten \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "reason": "Hedging review — positions closed pending clarification"
}
'

import requests

url = "https://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId}/flatten"

payload = { "reason": "Hedging review — positions closed pending clarification" }
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({reason: 'Hedging review — positions closed pending clarification'})
};

fetch('https://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId}/flatten', 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-accounts/{accountId}/flatten",
  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([
    'reason' => 'Hedging review — positions closed pending clarification'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId}/flatten"

	payload := strings.NewReader("{\n  \"reason\": \"Hedging review — positions closed pending clarification\"\n}")

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

	req.Header.Add("X-API-Key", "<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/trading-accounts/{accountId}/flatten")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"Hedging review — positions closed pending clarification\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reason\": \"Hedging review — positions closed pending clarification\"\n}"

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

{
  "success": true,
  "data": {
    "accountId": "<string>",
    "accountNumber": "ACME-50K-000123",
    "ordersCancelled": 1,
    "positionsClosed": 1,
    "reason": "Admin flatten: ops@firm.com — Hedging review"
  }
}

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

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

{
  "statusCode": 404,
  "error": "Not Found",
  "message": "Trading account not found",
  "code": "ACCOUNT_NOT_FOUND"
}

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

{
  "statusCode": 502,
  "error": "Bad Gateway",
  "message": "The trading engine did not accept the flatten request; nothing was closed",
  "code": "ENGINE_UNAVAILABLE"
}

Authorizations

X-API-Key

string

header

required

Organization API key. Format: "hp_live_{key}". Organization admins manage the key in the dashboard.

Path Parameters

accountId

string

required

Body

application/json

reason

string

required

Why the positions are being closed. Recorded on every resulting order and on the account's event log.

Required string length: 3 - 200

Example:

"Hedging review — positions closed pending clarification"

Response

Success - Positions closed and orders cancelled

success

boolean

Example:

true

data

object

Show child attributes

⌘I

Close all positions on an account

curl --request POST \
  --url https://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId}/flatten \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "reason": "Hedging review — positions closed pending clarification"
}
'

import requests

url = "https://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId}/flatten"

payload = { "reason": "Hedging review — positions closed pending clarification" }
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({reason: 'Hedging review — positions closed pending clarification'})
};

fetch('https://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId}/flatten', 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-accounts/{accountId}/flatten",
  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([
    'reason' => 'Hedging review — positions closed pending clarification'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId}/flatten"

	payload := strings.NewReader("{\n  \"reason\": \"Hedging review — positions closed pending clarification\"\n}")

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

	req.Header.Add("X-API-Key", "<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/trading-accounts/{accountId}/flatten")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"Hedging review — positions closed pending clarification\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reason\": \"Hedging review — positions closed pending clarification\"\n}"

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

{
  "success": true,
  "data": {
    "accountId": "<string>",
    "accountNumber": "ACME-50K-000123",
    "ordersCancelled": 1,
    "positionsClosed": 1,
    "reason": "Admin flatten: ops@firm.com — Hedging review"
  }
}

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

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

{
  "statusCode": 404,
  "error": "Not Found",
  "message": "Trading account not found",
  "code": "ACCOUNT_NOT_FOUND"
}

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

{
  "statusCode": 502,
  "error": "Bad Gateway",
  "message": "The trading engine did not accept the flatten request; nothing was closed",
  "code": "ENGINE_UNAVAILABLE"
}

Platform API

Trade API

Close all positions on an account

Authorizations

Path Parameters

Body

Response