Skip to navigation
REST API EndpointsAccounting

Reset Demo Account State

View as Markdown

Reset one or more demo accounts to their state at a previous trade date.

Available to: All authenticated users

Environments: Demo

Rate Limit: No endpoint-specific limit

Returns the specified simulation accounts to their state as of market open on a given trade date, discarding the activity that occurred after that date. Use this to roll a practice account back to a known starting point — for example, to restart an evaluation phase or clear out test trades.

Provide the accounts to reset in accountIds (an array of integer account entity IDs) and the target date in resetTradeDate. Look up account IDs with the accountList endpoint. The response is a SimpleResponse; check its ok flag and errorText field to confirm the reset.

This endpoint is available on Demo only. Resetting an account’s state cannot be undone.

Common Failure Scenarios

  • An entry in accountIds doesn’t exist or isn’t owned by the calling user.
  • resetTradeDate is missing or not a valid trade date.
  • The access token is missing or invalid (returns HTTP 401).

Error Messages

errorTextTrigger
Non-empty errorTextThe request failed; the field describes the reason.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
accountIdslist of longsRequired
resetTradeDateobjectRequired

Response

SimpleResponse
okboolean
errorTextstringOptional<=8192 characters

Non-empty if the request failed