Skip to main content
POST
Create user profile

Body

application/json
username
string
required
Required string length: 2 - 24
Pattern: ^[a-zA-Z0-9]+$
Example:

"johndoe"

displayName
string
Required string length: 2 - 50
Pattern: ^[a-zA-Z\s\-']+$
Example:

"John Doe"

name
string
Required string length: 2 - 100
Pattern: ^[a-zA-Z\s\-']+$
Example:

"John Michael Doe"

avatarUrl
string
Example:

"https://example.com/avatar.jpg"

bio
string
Maximum string length: 280
Example:

"Trader & investor"

firstName
string
Required string length: 1 - 50
Pattern: ^[a-zA-Z\s\-']+$
Example:

"John"

lastName
string
Required string length: 1 - 50
Pattern: ^[a-zA-Z\s\-']+$
Example:

"Doe"

dateOfBirth
string<date-time>
Example:

"1990-05-15"

nationality
string
Example:

"US"

countryOfResidence
string
Example:

"US"

address1
string
Maximum string length: 200
Example:

"123 Main St"

address2
string
Maximum string length: 200
Example:

"Apt 4B"

city
string
Maximum string length: 100
Example:

"New York"

region
string
Maximum string length: 100
Example:

"NY"

postal
string
Maximum string length: 20
Example:

"10001"

isPublic
boolean
default:false

Whether the profile is publicly visible

Example:

false

Public social links (one per platform)

Maximum array length: 5
showBadgesBehindName
boolean

Show pinned badges next to the display name

tradingIdentity
enum<string>[]

Selected trading-identity tag ids

Maximum array length: 5
Available options:
scalper,
day-trader,
swing-trader,
position,
long-only,
short-only,
both-sides,
news-trader,
overnight-holder,
extended-hours,
technical,
macro,
data-driven,
intuitive,
nq,
es,
cl,
gc,
si,
zb,
6e,
mnq,
mes
showPnlAmount
boolean

Show the user's P&L amount on public surfaces

pnlAsPercent
boolean

Render P&L as a percentage instead of a dollar value

Response

Profile created successfully

success
boolean
Example:

true

message
string
Example:

"Profile created successfully"

data
object