Retune or disable a test account
Updates a simulated account. Omitted or null fields keep their values. Disabling stops the account on the next scheduler sweep; retuning restarts a running account. Service tokens with accounts:admin may update any organization. Admins of configured internal organizations may update only their own accounts.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Simulated account id
Body
The fields to change. All values shown are placeholders.
Updates a simulated account. Omitted or null fields keep their values. Retuning restarts a running account; its environment remains paper.
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.
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.