Trading accounts

Deactivate a trading account

Turn off a trading account. The account moves to inactive status: it cannot trade and is not billed from the next calendar month. Use this when a trader hasn’t traded and a new month is about to start.

What happens:

Working orders are cancelled
Open positions are closed at market
The account status becomes inactive
The account stops counting toward your active trader bill

Requirements: The account must be in_progress or not_started. Already passed, failed, or expired accounts cannot be deactivated.

Webhooks: account.status_changed fires with trigger: "firm_deactivated" and the reason you provided.

Idempotent: Calling deactivate on an already-inactive account returns success with changed: false.

Example:

curl -X POST ".../v1/organization/trading-accounts/7c9e6679-7425-40de-944b-e07fc1f90ae7/deactivate" \
  -H "X-API-Key: hp_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ "reason": "Inactive for 14 days before month end" }'

POST

organization

trading-accounts

{accountId}

deactivate

Deactivate a trading account

curl --request POST \
  --url https://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId}/deactivate \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "reason": "Inactive for 14 days before month end"
}
'

import requests

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

payload = { "reason": "Inactive for 14 days before month end" }
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: 'Inactive for 14 days before month end'})
};

fetch('https://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId}/deactivate', 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}/deactivate",
  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' => 'Inactive for 14 days before month end'
  ]),
  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}/deactivate"

	payload := strings.NewReader("{\n  \"reason\": \"Inactive for 14 days before month end\"\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}/deactivate")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"Inactive for 14 days before month end\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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\": \"Inactive for 14 days before month end\"\n}"

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

{
  "changed": true,
  "status": "inactive"
}

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<uuid>

required

Trading account ID

Body

application/json

reason

string

Reason for deactivating (shown in webhooks and audit log)

Example:

"Inactive for 14 days before month end"

Response

Account deactivated (or already inactive)

changed

boolean

true if the status changed, false if already inactive

status

string

New account status

Example:

"inactive"

⌘I

Deactivate a trading account

curl --request POST \
  --url https://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId}/deactivate \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "reason": "Inactive for 14 days before month end"
}
'

import requests

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

payload = { "reason": "Inactive for 14 days before month end" }
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: 'Inactive for 14 days before month end'})
};

fetch('https://api.hyperprop.com/platform/v1/organization/trading-accounts/{accountId}/deactivate', 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}/deactivate",
  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' => 'Inactive for 14 days before month end'
  ]),
  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}/deactivate"

	payload := strings.NewReader("{\n  \"reason\": \"Inactive for 14 days before month end\"\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}/deactivate")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"Inactive for 14 days before month end\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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\": \"Inactive for 14 days before month end\"\n}"

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

{
  "changed": true,
  "status": "inactive"
}

Platform API

Trade API

Deactivate a trading account

Authorizations

Path Parameters

Body

Response