Skip to main content
POST
Create a paper trading account

Authorizations

x-app-api-key
string
header
required

App-scoped API key for programmatic app management.

Path Parameters

appId
string
required

Body

application/json
name
string
Required string length: 1 - 120
externalId
string
Required string length: 1 - 160
initialBalanceRaw
string
Pattern: ^[0-9]+$
initialBalance
number
Required range: x >= 0

Response

201

id
string
required
appId
string
required
name
string | null
required
externalId
string | null
required
currency
string
required
startingBalanceRaw
string
required
startingBalance
number
required
cashBalanceRaw
string
required
cashBalance
number
required
realizedPnlRaw
string
required
realizedPnl
number
required
kycStatus
enum<string>
required
Available options:
verified
kycVerified
enum<boolean>
required
Available options:
true
status
enum<string>
required
Available options:
active,
archived
createdAt
string
required
updatedAt
string
required