Skip to main content
POST

Authorizations

Authorization
string
header
required

Token-based authentication with required prefix "Token"

Body

user_id
integer
required

ID of the user who will own the trading account.

challenge_id
integer
required

Challenge or program identifier associated with the account. The first phase for the challenge is used.

phase_id
integer | null

Optional exact phase identifier for the account. When provided, it must belong to the selected challenge. When omitted or null, the first phase for the challenge is used.

initial_balance
string<decimal> | null

Optional account-level starting balance override. Precedence is explicit account initial_balance, then the selected Phase initial_balance, then the Challenge initial_balance.

Pattern: ^-?\d{0,12}(?:\.\d{0,2})?$
is_active
boolean
default:true

Whether the account is active immediately after creation.

notes
string | null

Optional notes or comments to store with the account.

Maximum string length: 2000

Response

201 - application/json

Standard serializer for operation responses. A command or a task should return a response matching this format. Operation = a request to perform some action, e.g. sync, update, delete, create, etc.

success
boolean
required

Indicates whether the operation completed successfully.

results
any[]
required

List containing the result items produced by the operation. The structure of each item depends on the executed operation.

summary
object
required

Aggregated summary information about the operation results (e.g. counts of updated, created, failed or unchanged records).

duration_ms
number<double>
required

Execution time of the operation in milliseconds.

message
string | null

Optional human-readable message describing the operation outcome.