Skip to main content

Profile and Settings

Manage your user profile, preferences, and public visibility through the profile API.

Viewing Your Profile​

GET /api/v1/users/me

Returns your full profile including name, nickname, email, language, theme, avatar URL, referral code, and wallet balances. Requires authentication.

Updating Your Profile​

PUT /api/v1/users/me

Send only the fields you want to change:

{
"name": "Jane Doe",
"nickname": "janedoe",
"language": "en",
"theme": "dark",
"profile_hidden": false
}
FieldTypeDescription
namestringYour display name.
nicknamestringA unique handle used in your public profile URL.
languagestringInterface language: en (English) or ru (Russian).
themestringUI theme: light or dark.
profile_hiddenbooleanWhen true, your profile is hidden from other users.

Checking Nickname Availability​

Before setting a nickname, you can verify it is not already taken:

GET /api/v1/users/nickname/available?nickname=janedoe

Returns a boolean indicating whether the nickname is available.

Avatar Management​

Uploading an Avatar​

POST /api/v1/users/me/avatar

Send the image as a multipart form upload. The image is stored in Cloudflare R2, and the resulting URL is saved to your profile.

Removing Your Avatar​

DELETE /api/v1/users/me/avatar

Removes your current avatar and reverts to the default.

Public Profiles​

Any user can view another user's public profile (unless that user has set profile_hidden to true):

  • By user ID: GET /api/v1/users/{id}
  • By nickname: GET /api/v1/users/by_nickname/{nickname}

Public profiles display the user's name, nickname, avatar, and trading statistics. Sensitive information such as email and wallet details is never exposed.

Summary of Endpoints​

MethodEndpointAuthDescription
GET/api/v1/users/meRequiredGet your own profile
PUT/api/v1/users/meRequiredUpdate profile fields
POST/api/v1/users/me/avatarRequiredUpload avatar image
DELETE/api/v1/users/me/avatarRequiredRemove avatar
GET/api/v1/users/nickname/availableRequiredCheck nickname availability
GET/api/v1/users/{id}OptionalView user profile by ID
GET/api/v1/users/by_nickname/{nickname}OptionalView user profile by nickname