User

Update user profile

Updates the authenticated user’s profile. All fields are optional. Nationality should be ISO 3166-1 alpha-2 code (e.g., US, GB, NL). If the user has no profile yet, one is auto-created with a public placeholder username (user + id prefix) and the updates are applied to it — completing KYC never requires visiting the profile page first. Public profiles participate in the leaderboard automatically unless explicitly opted out. Setting leaderboardOptIn to false saves an opt-out across privacy changes. Setting isPublic to false hides the trader immediately while preserving their participation preference; publishing again resumes participation unless opted out. Newly participating traders appear after their first performance refresh.

PUT

user

profile

Update user profile

curl --request PUT \
  --url https://api.hyperprop.com/platform/v1/user/profile \
  --header 'Content-Type: application/json' \
  --data '
{
  "username": "johndoe2",
  "displayName": "John Doe",
  "name": "John Michael Doe",
  "avatarUrl": "https://example.com/new-avatar.jpg",
  "bio": "Updated bio",
  "firstName": "John",
  "lastName": "Doe",
  "dateOfBirth": "1990-05-15",
  "nationality": "US",
  "countryOfResidence": "US",
  "address1": "123 Main St",
  "address2": "Apt 4B",
  "city": "New York",
  "region": "NY",
  "postal": "10001",
  "isPublic": true,
  "leaderboardOptIn": false,
  "socialLinks": [
    {
      "url": "<string>"
    }
  ],
  "showBadgesBehindName": true,
  "tradingIdentity": [],
  "showPnlAmount": true,
  "pnlAsPercent": true,
  "leaderboardAnonymous": true
}
'

import requests

url = "https://api.hyperprop.com/platform/v1/user/profile"

payload = {
    "username": "johndoe2",
    "displayName": "John Doe",
    "name": "John Michael Doe",
    "avatarUrl": "https://example.com/new-avatar.jpg",
    "bio": "Updated bio",
    "firstName": "John",
    "lastName": "Doe",
    "dateOfBirth": "1990-05-15",
    "nationality": "US",
    "countryOfResidence": "US",
    "address1": "123 Main St",
    "address2": "Apt 4B",
    "city": "New York",
    "region": "NY",
    "postal": "10001",
    "isPublic": True,
    "leaderboardOptIn": False,
    "socialLinks": [{ "url": "<string>" }],
    "showBadgesBehindName": True,
    "tradingIdentity": [],
    "showPnlAmount": True,
    "pnlAsPercent": True,
    "leaderboardAnonymous": True
}
headers = {"Content-Type": "application/json"}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    username: 'johndoe2',
    displayName: 'John Doe',
    name: 'John Michael Doe',
    avatarUrl: 'https://example.com/new-avatar.jpg',
    bio: 'Updated bio',
    firstName: 'John',
    lastName: 'Doe',
    dateOfBirth: '1990-05-15',
    nationality: 'US',
    countryOfResidence: 'US',
    address1: '123 Main St',
    address2: 'Apt 4B',
    city: 'New York',
    region: 'NY',
    postal: '10001',
    isPublic: true,
    leaderboardOptIn: false,
    socialLinks: [{url: '<string>'}],
    showBadgesBehindName: true,
    tradingIdentity: [],
    showPnlAmount: true,
    pnlAsPercent: true,
    leaderboardAnonymous: true
  })
};

fetch('https://api.hyperprop.com/platform/v1/user/profile', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hyperprop.com/platform/v1/user/profile",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'username' => 'johndoe2',
    'displayName' => 'John Doe',
    'name' => 'John Michael Doe',
    'avatarUrl' => 'https://example.com/new-avatar.jpg',
    'bio' => 'Updated bio',
    'firstName' => 'John',
    'lastName' => 'Doe',
    'dateOfBirth' => '1990-05-15',
    'nationality' => 'US',
    'countryOfResidence' => 'US',
    'address1' => '123 Main St',
    'address2' => 'Apt 4B',
    'city' => 'New York',
    'region' => 'NY',
    'postal' => '10001',
    'isPublic' => true,
    'leaderboardOptIn' => false,
    'socialLinks' => [
        [
                'url' => '<string>'
        ]
    ],
    'showBadgesBehindName' => true,
    'tradingIdentity' => [
        
    ],
    'showPnlAmount' => true,
    'pnlAsPercent' => true,
    'leaderboardAnonymous' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hyperprop.com/platform/v1/user/profile"

	payload := strings.NewReader("{\n  \"username\": \"johndoe2\",\n  \"displayName\": \"John Doe\",\n  \"name\": \"John Michael Doe\",\n  \"avatarUrl\": \"https://example.com/new-avatar.jpg\",\n  \"bio\": \"Updated bio\",\n  \"firstName\": \"John\",\n  \"lastName\": \"Doe\",\n  \"dateOfBirth\": \"1990-05-15\",\n  \"nationality\": \"US\",\n  \"countryOfResidence\": \"US\",\n  \"address1\": \"123 Main St\",\n  \"address2\": \"Apt 4B\",\n  \"city\": \"New York\",\n  \"region\": \"NY\",\n  \"postal\": \"10001\",\n  \"isPublic\": true,\n  \"leaderboardOptIn\": false,\n  \"socialLinks\": [\n    {\n      \"url\": \"<string>\"\n    }\n  ],\n  \"showBadgesBehindName\": true,\n  \"tradingIdentity\": [],\n  \"showPnlAmount\": true,\n  \"pnlAsPercent\": true,\n  \"leaderboardAnonymous\": true\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.hyperprop.com/platform/v1/user/profile")
  .header("Content-Type", "application/json")
  .body("{\n  \"username\": \"johndoe2\",\n  \"displayName\": \"John Doe\",\n  \"name\": \"John Michael Doe\",\n  \"avatarUrl\": \"https://example.com/new-avatar.jpg\",\n  \"bio\": \"Updated bio\",\n  \"firstName\": \"John\",\n  \"lastName\": \"Doe\",\n  \"dateOfBirth\": \"1990-05-15\",\n  \"nationality\": \"US\",\n  \"countryOfResidence\": \"US\",\n  \"address1\": \"123 Main St\",\n  \"address2\": \"Apt 4B\",\n  \"city\": \"New York\",\n  \"region\": \"NY\",\n  \"postal\": \"10001\",\n  \"isPublic\": true,\n  \"leaderboardOptIn\": false,\n  \"socialLinks\": [\n    {\n      \"url\": \"<string>\"\n    }\n  ],\n  \"showBadgesBehindName\": true,\n  \"tradingIdentity\": [],\n  \"showPnlAmount\": true,\n  \"pnlAsPercent\": true,\n  \"leaderboardAnonymous\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hyperprop.com/platform/v1/user/profile")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"username\": \"johndoe2\",\n  \"displayName\": \"John Doe\",\n  \"name\": \"John Michael Doe\",\n  \"avatarUrl\": \"https://example.com/new-avatar.jpg\",\n  \"bio\": \"Updated bio\",\n  \"firstName\": \"John\",\n  \"lastName\": \"Doe\",\n  \"dateOfBirth\": \"1990-05-15\",\n  \"nationality\": \"US\",\n  \"countryOfResidence\": \"US\",\n  \"address1\": \"123 Main St\",\n  \"address2\": \"Apt 4B\",\n  \"city\": \"New York\",\n  \"region\": \"NY\",\n  \"postal\": \"10001\",\n  \"isPublic\": true,\n  \"leaderboardOptIn\": false,\n  \"socialLinks\": [\n    {\n      \"url\": \"<string>\"\n    }\n  ],\n  \"showBadgesBehindName\": true,\n  \"tradingIdentity\": [],\n  \"showPnlAmount\": true,\n  \"pnlAsPercent\": true,\n  \"leaderboardAnonymous\": true\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "Profile updated successfully",
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "userId": "550e8400-e29b-41d4-a716-446655440001",
    "username": "johndoe",
    "displayName": "John Doe",
    "name": "John Michael Doe",
    "avatarUrl": "https://example.com/avatar.jpg",
    "bio": "Trader & investor",
    "dateOfBirth": "1990-05-15",
    "nationality": "US",
    "isPublic": true,
    "leaderboardOptIn": false,
    "createdAt": "2026-09-17T12:00:00.000Z",
    "updatedAt": "2026-09-17T12:00:00.000Z"
  }
}

{
  "success": false,
  "statusCode": 400,
  "error": "Bad Request",
  "message": "A public profile with a username is required to join the leaderboard",
  "code": "LEADERBOARD_PUBLIC_PROFILE_REQUIRED"
}

{
  "success": false,
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Authentication required",
  "code": "UNAUTHORIZED"
}

{
  "success": false,
  "statusCode": 409,
  "error": "Conflict",
  "message": "Username is already taken",
  "code": "USERNAME_TAKEN"
}

{
  "success": false,
  "statusCode": 500,
  "error": "Internal Server Error",
  "message": "An unexpected error occurred",
  "code": "INTERNAL_ERROR"
}

Body

application/json

username

string

Required string length: 2 - 24

Pattern: ^[a-zA-Z0-9]+$

Example:

"johndoe2"

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/new-avatar.jpg"

bio

string

Maximum string length: 280

Example:

"Updated bio"

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

Whether the profile is publicly visible

Example:

true

leaderboardOptIn

boolean

Whether the trader participates in the public leaderboard, which publishes dollar P&L and performance metrics independently of Social Feed display settings. Public profiles participate automatically unless explicitly opted out. Setting false saves an opt-out across later privacy changes. Private profiles are excluded; publishing again resumes participation unless opted out.

Example:

false

Public social links (one per platform)

Maximum array length: 5

Show child attributes

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

leaderboardAnonymous

boolean

Hide username and avatar on the leaderboard; the trader still competes under a stable anonymous alias. Independent of isPublic. Defaults to true; traders opt in to showing their name.

Response

Profile updated successfully

success

boolean

Example:

true

message

string

Example:

"Profile updated successfully"

data

object

Show child attributes

⌘I

Update user profile

curl --request PUT \
  --url https://api.hyperprop.com/platform/v1/user/profile \
  --header 'Content-Type: application/json' \
  --data '
{
  "username": "johndoe2",
  "displayName": "John Doe",
  "name": "John Michael Doe",
  "avatarUrl": "https://example.com/new-avatar.jpg",
  "bio": "Updated bio",
  "firstName": "John",
  "lastName": "Doe",
  "dateOfBirth": "1990-05-15",
  "nationality": "US",
  "countryOfResidence": "US",
  "address1": "123 Main St",
  "address2": "Apt 4B",
  "city": "New York",
  "region": "NY",
  "postal": "10001",
  "isPublic": true,
  "leaderboardOptIn": false,
  "socialLinks": [
    {
      "url": "<string>"
    }
  ],
  "showBadgesBehindName": true,
  "tradingIdentity": [],
  "showPnlAmount": true,
  "pnlAsPercent": true,
  "leaderboardAnonymous": true
}
'

import requests

url = "https://api.hyperprop.com/platform/v1/user/profile"

payload = {
    "username": "johndoe2",
    "displayName": "John Doe",
    "name": "John Michael Doe",
    "avatarUrl": "https://example.com/new-avatar.jpg",
    "bio": "Updated bio",
    "firstName": "John",
    "lastName": "Doe",
    "dateOfBirth": "1990-05-15",
    "nationality": "US",
    "countryOfResidence": "US",
    "address1": "123 Main St",
    "address2": "Apt 4B",
    "city": "New York",
    "region": "NY",
    "postal": "10001",
    "isPublic": True,
    "leaderboardOptIn": False,
    "socialLinks": [{ "url": "<string>" }],
    "showBadgesBehindName": True,
    "tradingIdentity": [],
    "showPnlAmount": True,
    "pnlAsPercent": True,
    "leaderboardAnonymous": True
}
headers = {"Content-Type": "application/json"}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    username: 'johndoe2',
    displayName: 'John Doe',
    name: 'John Michael Doe',
    avatarUrl: 'https://example.com/new-avatar.jpg',
    bio: 'Updated bio',
    firstName: 'John',
    lastName: 'Doe',
    dateOfBirth: '1990-05-15',
    nationality: 'US',
    countryOfResidence: 'US',
    address1: '123 Main St',
    address2: 'Apt 4B',
    city: 'New York',
    region: 'NY',
    postal: '10001',
    isPublic: true,
    leaderboardOptIn: false,
    socialLinks: [{url: '<string>'}],
    showBadgesBehindName: true,
    tradingIdentity: [],
    showPnlAmount: true,
    pnlAsPercent: true,
    leaderboardAnonymous: true
  })
};

fetch('https://api.hyperprop.com/platform/v1/user/profile', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hyperprop.com/platform/v1/user/profile",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'username' => 'johndoe2',
    'displayName' => 'John Doe',
    'name' => 'John Michael Doe',
    'avatarUrl' => 'https://example.com/new-avatar.jpg',
    'bio' => 'Updated bio',
    'firstName' => 'John',
    'lastName' => 'Doe',
    'dateOfBirth' => '1990-05-15',
    'nationality' => 'US',
    'countryOfResidence' => 'US',
    'address1' => '123 Main St',
    'address2' => 'Apt 4B',
    'city' => 'New York',
    'region' => 'NY',
    'postal' => '10001',
    'isPublic' => true,
    'leaderboardOptIn' => false,
    'socialLinks' => [
        [
                'url' => '<string>'
        ]
    ],
    'showBadgesBehindName' => true,
    'tradingIdentity' => [
        
    ],
    'showPnlAmount' => true,
    'pnlAsPercent' => true,
    'leaderboardAnonymous' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hyperprop.com/platform/v1/user/profile"

	payload := strings.NewReader("{\n  \"username\": \"johndoe2\",\n  \"displayName\": \"John Doe\",\n  \"name\": \"John Michael Doe\",\n  \"avatarUrl\": \"https://example.com/new-avatar.jpg\",\n  \"bio\": \"Updated bio\",\n  \"firstName\": \"John\",\n  \"lastName\": \"Doe\",\n  \"dateOfBirth\": \"1990-05-15\",\n  \"nationality\": \"US\",\n  \"countryOfResidence\": \"US\",\n  \"address1\": \"123 Main St\",\n  \"address2\": \"Apt 4B\",\n  \"city\": \"New York\",\n  \"region\": \"NY\",\n  \"postal\": \"10001\",\n  \"isPublic\": true,\n  \"leaderboardOptIn\": false,\n  \"socialLinks\": [\n    {\n      \"url\": \"<string>\"\n    }\n  ],\n  \"showBadgesBehindName\": true,\n  \"tradingIdentity\": [],\n  \"showPnlAmount\": true,\n  \"pnlAsPercent\": true,\n  \"leaderboardAnonymous\": true\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.hyperprop.com/platform/v1/user/profile")
  .header("Content-Type", "application/json")
  .body("{\n  \"username\": \"johndoe2\",\n  \"displayName\": \"John Doe\",\n  \"name\": \"John Michael Doe\",\n  \"avatarUrl\": \"https://example.com/new-avatar.jpg\",\n  \"bio\": \"Updated bio\",\n  \"firstName\": \"John\",\n  \"lastName\": \"Doe\",\n  \"dateOfBirth\": \"1990-05-15\",\n  \"nationality\": \"US\",\n  \"countryOfResidence\": \"US\",\n  \"address1\": \"123 Main St\",\n  \"address2\": \"Apt 4B\",\n  \"city\": \"New York\",\n  \"region\": \"NY\",\n  \"postal\": \"10001\",\n  \"isPublic\": true,\n  \"leaderboardOptIn\": false,\n  \"socialLinks\": [\n    {\n      \"url\": \"<string>\"\n    }\n  ],\n  \"showBadgesBehindName\": true,\n  \"tradingIdentity\": [],\n  \"showPnlAmount\": true,\n  \"pnlAsPercent\": true,\n  \"leaderboardAnonymous\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hyperprop.com/platform/v1/user/profile")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"username\": \"johndoe2\",\n  \"displayName\": \"John Doe\",\n  \"name\": \"John Michael Doe\",\n  \"avatarUrl\": \"https://example.com/new-avatar.jpg\",\n  \"bio\": \"Updated bio\",\n  \"firstName\": \"John\",\n  \"lastName\": \"Doe\",\n  \"dateOfBirth\": \"1990-05-15\",\n  \"nationality\": \"US\",\n  \"countryOfResidence\": \"US\",\n  \"address1\": \"123 Main St\",\n  \"address2\": \"Apt 4B\",\n  \"city\": \"New York\",\n  \"region\": \"NY\",\n  \"postal\": \"10001\",\n  \"isPublic\": true,\n  \"leaderboardOptIn\": false,\n  \"socialLinks\": [\n    {\n      \"url\": \"<string>\"\n    }\n  ],\n  \"showBadgesBehindName\": true,\n  \"tradingIdentity\": [],\n  \"showPnlAmount\": true,\n  \"pnlAsPercent\": true,\n  \"leaderboardAnonymous\": true\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "Profile updated successfully",
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "userId": "550e8400-e29b-41d4-a716-446655440001",
    "username": "johndoe",
    "displayName": "John Doe",
    "name": "John Michael Doe",
    "avatarUrl": "https://example.com/avatar.jpg",
    "bio": "Trader & investor",
    "dateOfBirth": "1990-05-15",
    "nationality": "US",
    "isPublic": true,
    "leaderboardOptIn": false,
    "createdAt": "2026-09-17T12:00:00.000Z",
    "updatedAt": "2026-09-17T12:00:00.000Z"
  }
}

{
  "success": false,
  "statusCode": 400,
  "error": "Bad Request",
  "message": "A public profile with a username is required to join the leaderboard",
  "code": "LEADERBOARD_PUBLIC_PROFILE_REQUIRED"
}

{
  "success": false,
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Authentication required",
  "code": "UNAUTHORIZED"
}

{
  "success": false,
  "statusCode": 409,
  "error": "Conflict",
  "message": "Username is already taken",
  "code": "USERNAME_TAKEN"
}

{
  "success": false,
  "statusCode": 500,
  "error": "Internal Server Error",
  "message": "An unexpected error occurred",
  "code": "INTERNAL_ERROR"
}

Platform API

Trade API

Market Data API

Update user profile

Body

Response