API ReferencePaper Trading

Reset paper wallet

Reset the paper wallet and delete all paper trading history.

Authentication

AuthorizationBearer

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

Headers

X-API-Keystring or nullOptional
Idempotency-KeystringOptional<=255 characters

Client-supplied key that makes this unsafe mutation retry-safe. Reusing a key with the same request replays the original result (the response then carries Idempotency-Replayed: true); reusing it with a different request returns 409. Optional but strongly recommended so a network retry cannot double-apply.

Request

This endpoint expects an object.
starting_balancedouble or stringOptionalDefaults to 10000.00
Starting balance for the reset wallet

Response

Successful Response
balancestringformat: "^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$"
Available virtual balance in CAD
created_atdatetime
idstringformat: "uuid"
locked_balancestringformat: "^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$"
Virtual balance locked in orders
net_profitstringformat: "^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$"
total_balancestringformat: "^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$"

Total virtual balance (available + locked)

total_depositedstringformat: "^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$"
total_fees_paidstringformat: "^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$"
total_lossesstringformat: "^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$"
total_winningsstringformat: "^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$"
updated_atdatetime
user_idstringformat: "uuid"

Errors

401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error