Test Accounts

Retune or disable a test account

Updates a registered simulated account. Every field is optional and an omitted field keeps its stored value. Setting enabled to false takes the account out of service on the scheduler’s next sweep while keeping the registration. Retuning an account that is running restarts it with the new timings. Callable by a client credential holding the accounts:admin scope, which may retune any organization’s account, and by an organization admin of a configured internal organization, which may retune only its own organization’s accounts.

PATCH

accounts

test

{trading_account_id}

Retune or disable a test account

curl --request PATCH \
  --url https://api.anthid.com/v1/accounts/test/{trading_account_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "enabled": false
}
'

import requests

url = "https://api.anthid.com/v1/accounts/test/{trading_account_id}"

payload = { "enabled": False }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({enabled: false})
};

fetch('https://api.anthid.com/v1/accounts/test/{trading_account_id}', 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.anthid.com/v1/accounts/test/{trading_account_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'enabled' => false
  ]),
  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.anthid.com/v1/accounts/test/{trading_account_id}"

	payload := strings.NewReader("{\n  \"enabled\": false\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.anthid.com/v1/accounts/test/{trading_account_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"enabled\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.anthid.com/v1/accounts/test/{trading_account_id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"enabled\": false\n}"

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

{
  "test_account": {
    "ack_latency_ms": 0,
    "created_at": "2026-08-25T17:04:57Z",
    "created_by": "an_YcKlZQeuLOoB5BcqlOrnV6a0",
    "enabled": false,
    "environment": "paper",
    "fill_max_ms": 100,
    "fill_min_ms": 5,
    "name": "load-test-01",
    "organization_id": "550e8400-e29b-41d4-a716-446655440000",
    "trading_account_id": "550e8400-e29b-41d4-a716-446655440111",
    "updated_at": "2026-08-25T18:12:03Z"
  }
}

"<string>"

"<string>"

"<string>"

"<string>"

"<string>"

"<string>"

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

trading_account_id

string<uuid>

required

Simulated account id

Body

application/json

The fields to change. All values shown are placeholders.

A partial update to a registered test account.

Every field optional: an omitted one keeps its stored value. environment is absent deliberately, not forgotten -- a test account is paper and the table refuses anything else, so a field for it would only ever be refused.

Retuning an account that is currently running restarts it. The scheduler notices the account's updated_at moved, stops the client and starts a fresh one with the new timings, which is the same path a real account takes when its credential is rotated.

ack_latency_ms

integer<int32> | null

enabled

boolean | null

Set false to take the account out of service. The scheduler's next sweep stops its client; the registration stays so it can be re-enabled.

fill_max_ms

integer<int32> | null

fill_min_ms

integer<int32> | null

name

string | null

Response

Test account updated

The registered test account, echoed back in full.

The whole row rather than just its id, because the request may have left the simulator's timings out and the operator needs to see which defaults they got without a second call.

test_account

object

required

A simulated trading account, registered by an operator for load testing.

Not a [TradingAccount] with a flag on it, and deliberately so. A trading account is a customer's broker connection: it has a broker, a credential, an append-only event stream behind it and a six year retention obligation. This has none of those. It is a row an operator adds to make the platform trade against an in-process simulator, and removes again afterwards.

Keeping the two types apart is what lets GET /v1/accounts answer one question at a time: without test_accounts=true it lists real accounts and cannot accidentally include one of these, and with it, it lists only these. A shared type carrying a boolean would have made every caller responsible for checking that boolean, and the cost of one forgetting is a customer's orders going to a simulator.

Show child attributes

Retune or disable a test account

curl --request PATCH \
  --url https://api.anthid.com/v1/accounts/test/{trading_account_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "enabled": false
}
'

import requests

url = "https://api.anthid.com/v1/accounts/test/{trading_account_id}"

payload = { "enabled": False }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({enabled: false})
};

fetch('https://api.anthid.com/v1/accounts/test/{trading_account_id}', 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.anthid.com/v1/accounts/test/{trading_account_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'enabled' => false
  ]),
  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.anthid.com/v1/accounts/test/{trading_account_id}"

	payload := strings.NewReader("{\n  \"enabled\": false\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.anthid.com/v1/accounts/test/{trading_account_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"enabled\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.anthid.com/v1/accounts/test/{trading_account_id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"enabled\": false\n}"

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

{
  "test_account": {
    "ack_latency_ms": 0,
    "created_at": "2026-08-25T17:04:57Z",
    "created_by": "an_YcKlZQeuLOoB5BcqlOrnV6a0",
    "enabled": false,
    "environment": "paper",
    "fill_max_ms": 100,
    "fill_min_ms": 5,
    "name": "load-test-01",
    "organization_id": "550e8400-e29b-41d4-a716-446655440000",
    "trading_account_id": "550e8400-e29b-41d4-a716-446655440111",
    "updated_at": "2026-08-25T18:12:03Z"
  }
}

"<string>"

"<string>"

"<string>"

"<string>"

"<string>"

"<string>"

Connections

Organizations

Controls

Accounts

Intents

Ledger

Stream

MCP

Retune or disable a test account

Authorizations

Path Parameters

Body

Response