User
Create user profile
Creates a profile for the authenticated user. Username must be unique. Nationality should be ISO 3166-1 alpha-2 code (e.g., US, GB, NL). Profile is private by default.
POST
/
v1
/
user
/
profile
Create user profile
curl --request POST \
--url https://api.hyperprop.com/platform/v1/user/profile \
--header 'Content-Type: application/json' \
--data '
{
"username": "johndoe",
"displayName": "John Doe",
"name": "John Michael Doe",
"avatarUrl": "https://example.com/avatar.jpg",
"bio": "Trader & investor",
"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": false,
"socialLinks": [
{
"url": "<string>"
}
],
"showBadgesBehindName": true,
"tradingIdentity": [],
"showPnlAmount": true,
"pnlAsPercent": true
}
'import requests
url = "https://api.hyperprop.com/platform/v1/user/profile"
payload = {
"username": "johndoe",
"displayName": "John Doe",
"name": "John Michael Doe",
"avatarUrl": "https://example.com/avatar.jpg",
"bio": "Trader & investor",
"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": False,
"socialLinks": [{ "url": "<string>" }],
"showBadgesBehindName": True,
"tradingIdentity": [],
"showPnlAmount": True,
"pnlAsPercent": True
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
username: 'johndoe',
displayName: 'John Doe',
name: 'John Michael Doe',
avatarUrl: 'https://example.com/avatar.jpg',
bio: 'Trader & investor',
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: false,
socialLinks: [{url: '<string>'}],
showBadgesBehindName: true,
tradingIdentity: [],
showPnlAmount: true,
pnlAsPercent: 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 => "POST",
CURLOPT_POSTFIELDS => json_encode([
'username' => 'johndoe',
'displayName' => 'John Doe',
'name' => 'John Michael Doe',
'avatarUrl' => 'https://example.com/avatar.jpg',
'bio' => 'Trader & investor',
'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' => false,
'socialLinks' => [
[
'url' => '<string>'
]
],
'showBadgesBehindName' => true,
'tradingIdentity' => [
],
'showPnlAmount' => true,
'pnlAsPercent' => 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\": \"johndoe\",\n \"displayName\": \"John Doe\",\n \"name\": \"John Michael Doe\",\n \"avatarUrl\": \"https://example.com/avatar.jpg\",\n \"bio\": \"Trader & investor\",\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\": false,\n \"socialLinks\": [\n {\n \"url\": \"<string>\"\n }\n ],\n \"showBadgesBehindName\": true,\n \"tradingIdentity\": [],\n \"showPnlAmount\": true,\n \"pnlAsPercent\": true\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.hyperprop.com/platform/v1/user/profile")
.header("Content-Type", "application/json")
.body("{\n \"username\": \"johndoe\",\n \"displayName\": \"John Doe\",\n \"name\": \"John Michael Doe\",\n \"avatarUrl\": \"https://example.com/avatar.jpg\",\n \"bio\": \"Trader & investor\",\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\": false,\n \"socialLinks\": [\n {\n \"url\": \"<string>\"\n }\n ],\n \"showBadgesBehindName\": true,\n \"tradingIdentity\": [],\n \"showPnlAmount\": true,\n \"pnlAsPercent\": 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::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"username\": \"johndoe\",\n \"displayName\": \"John Doe\",\n \"name\": \"John Michael Doe\",\n \"avatarUrl\": \"https://example.com/avatar.jpg\",\n \"bio\": \"Trader & investor\",\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\": false,\n \"socialLinks\": [\n {\n \"url\": \"<string>\"\n }\n ],\n \"showBadgesBehindName\": true,\n \"tradingIdentity\": [],\n \"showPnlAmount\": true,\n \"pnlAsPercent\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Profile created successfully",
"data": {
"profile": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"user_id": "550e8400-e29b-41d4-a716-446655440001",
"username": "johndoe",
"display_name": "John Doe",
"name": "John Michael Doe",
"avatar_url": "https://example.com/avatar.jpg",
"bio": "Trader & investor",
"date_of_birth": "1990-05-15",
"nationality": "US",
"is_public": false,
"created_at": "2025-01-15T10:00:00.000Z"
}
}
}{
"success": false,
"statusCode": 401,
"error": "Unauthorized",
"message": "Authentication required",
"code": "UNAUTHORIZED"
}{
"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
Required string length:
2 - 24Pattern:
^[a-zA-Z0-9]+$Example:
"johndoe"
Required string length:
2 - 50Pattern:
^[a-zA-Z\s\-']+$Example:
"John Doe"
Required string length:
2 - 100Pattern:
^[a-zA-Z\s\-']+$Example:
"John Michael Doe"
Example:
"https://example.com/avatar.jpg"
Maximum string length:
280Example:
"Trader & investor"
Required string length:
1 - 50Pattern:
^[a-zA-Z\s\-']+$Example:
"John"
Required string length:
1 - 50Pattern:
^[a-zA-Z\s\-']+$Example:
"Doe"
Example:
"1990-05-15"
Example:
"US"
Example:
"US"
Maximum string length:
200Example:
"123 Main St"
Maximum string length:
200Example:
"Apt 4B"
Maximum string length:
100Example:
"New York"
Maximum string length:
100Example:
"NY"
Maximum string length:
20Example:
"10001"
Whether the profile is publicly visible
Example:
false
Public social links (one per platform)
Maximum array length:
5Show child attributes
Show child attributes
Show pinned badges next to the display name
Selected trading-identity tag ids
Maximum array length:
5Available 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 Show the user's P&L amount on public surfaces
Render P&L as a percentage instead of a dollar value
Related topics
Update user profileDelete user profileGet user profile by usernameGet own user profileGet user profile by account registration number⌘I
Create user profile
curl --request POST \
--url https://api.hyperprop.com/platform/v1/user/profile \
--header 'Content-Type: application/json' \
--data '
{
"username": "johndoe",
"displayName": "John Doe",
"name": "John Michael Doe",
"avatarUrl": "https://example.com/avatar.jpg",
"bio": "Trader & investor",
"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": false,
"socialLinks": [
{
"url": "<string>"
}
],
"showBadgesBehindName": true,
"tradingIdentity": [],
"showPnlAmount": true,
"pnlAsPercent": true
}
'import requests
url = "https://api.hyperprop.com/platform/v1/user/profile"
payload = {
"username": "johndoe",
"displayName": "John Doe",
"name": "John Michael Doe",
"avatarUrl": "https://example.com/avatar.jpg",
"bio": "Trader & investor",
"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": False,
"socialLinks": [{ "url": "<string>" }],
"showBadgesBehindName": True,
"tradingIdentity": [],
"showPnlAmount": True,
"pnlAsPercent": True
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
username: 'johndoe',
displayName: 'John Doe',
name: 'John Michael Doe',
avatarUrl: 'https://example.com/avatar.jpg',
bio: 'Trader & investor',
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: false,
socialLinks: [{url: '<string>'}],
showBadgesBehindName: true,
tradingIdentity: [],
showPnlAmount: true,
pnlAsPercent: 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 => "POST",
CURLOPT_POSTFIELDS => json_encode([
'username' => 'johndoe',
'displayName' => 'John Doe',
'name' => 'John Michael Doe',
'avatarUrl' => 'https://example.com/avatar.jpg',
'bio' => 'Trader & investor',
'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' => false,
'socialLinks' => [
[
'url' => '<string>'
]
],
'showBadgesBehindName' => true,
'tradingIdentity' => [
],
'showPnlAmount' => true,
'pnlAsPercent' => 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\": \"johndoe\",\n \"displayName\": \"John Doe\",\n \"name\": \"John Michael Doe\",\n \"avatarUrl\": \"https://example.com/avatar.jpg\",\n \"bio\": \"Trader & investor\",\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\": false,\n \"socialLinks\": [\n {\n \"url\": \"<string>\"\n }\n ],\n \"showBadgesBehindName\": true,\n \"tradingIdentity\": [],\n \"showPnlAmount\": true,\n \"pnlAsPercent\": true\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.hyperprop.com/platform/v1/user/profile")
.header("Content-Type", "application/json")
.body("{\n \"username\": \"johndoe\",\n \"displayName\": \"John Doe\",\n \"name\": \"John Michael Doe\",\n \"avatarUrl\": \"https://example.com/avatar.jpg\",\n \"bio\": \"Trader & investor\",\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\": false,\n \"socialLinks\": [\n {\n \"url\": \"<string>\"\n }\n ],\n \"showBadgesBehindName\": true,\n \"tradingIdentity\": [],\n \"showPnlAmount\": true,\n \"pnlAsPercent\": 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::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"username\": \"johndoe\",\n \"displayName\": \"John Doe\",\n \"name\": \"John Michael Doe\",\n \"avatarUrl\": \"https://example.com/avatar.jpg\",\n \"bio\": \"Trader & investor\",\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\": false,\n \"socialLinks\": [\n {\n \"url\": \"<string>\"\n }\n ],\n \"showBadgesBehindName\": true,\n \"tradingIdentity\": [],\n \"showPnlAmount\": true,\n \"pnlAsPercent\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Profile created successfully",
"data": {
"profile": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"user_id": "550e8400-e29b-41d4-a716-446655440001",
"username": "johndoe",
"display_name": "John Doe",
"name": "John Michael Doe",
"avatar_url": "https://example.com/avatar.jpg",
"bio": "Trader & investor",
"date_of_birth": "1990-05-15",
"nationality": "US",
"is_public": false,
"created_at": "2025-01-15T10:00:00.000Z"
}
}
}{
"success": false,
"statusCode": 401,
"error": "Unauthorized",
"message": "Authentication required",
"code": "UNAUTHORIZED"
}{
"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"
}