ProfileService

Get Profile

Retrieve the caller's profile.

Method

GET

Path

/v1/auth/profile

Visibility

Authentication required

Authentication

Session token

MFA Requirement

Not required

GET

/v1/auth/profile

Request

Testnet

curl --request GET \ \
  --url 'https://api.testnet.polyester.com/v1/auth/profile' \
  --header 'Accept: */*' \
  --header 'X-API-KEY-ID: YOUR_API_KEY_ID' \
  --header 'X-API-TIMESTAMP: YOUR_API_TIMESTAMP' \
  --header 'X-API-SIGNATURE: YOUR_API_SIGNATURE'

Responses

{
  "avatarUrl": "https://placehold.co/128x128.png",
  "bio": "Professional crypto trader and liquidity provider.",
  "createdAt": "2025-01-01T00:00:00Z",
  "currentTermsAccepted": false,
  "discord": "polyester_trader",
  "discordVerified": false,
  "nextUsernameChangeAt": "2025-01-01T00:00:00Z",
  "twitter": "@polyester_exchange",
  "twitterVerified": false,
  "username": "trader_alpha",
  "usernameUnlocked": false,
  "vipTier": 1,
  "website": "https://example.com"
}

username string

Public username for the root account. Usernames are unique case-insensitively and use 3 to 32 letters, digits, underscores, dots, or hyphens. Empty means no username is set.

Example trader_alpha

bio string

Short public bio. Maximum length is 256 characters.

Example Professional crypto trader and liquidity provider.

website string

Public website URL, if set. Maximum length is 256 characters.

Example https://example.com

twitter string

X/Twitter handle without "@". Maximum length is 15 characters.

Example @polyester_exchange

twitterVerified boolean

Whether the X/Twitter handle for this account has been verified.

Example false

discord string

Discord handle or username without "@". Maximum length is 64 characters.

Example polyester_trader

discordVerified boolean

Whether the Discord handle for this account has been verified.

Example false

avatarUrl string

Avatar URL, if set. Maximum length is 256 characters.

Example https://placehold.co/128x128.png

createdAt string (date-time)

Account creation time in UTC. This is the canonical "member since" timestamp.

Example 2025-01-01T00:00:00Z

nextUsernameChangeAt string (date-time)

Next time in UTC when the username can be changed again. Omitted when no cooldown applies.

Example 2025-01-01T00:00:00Z

vipTier integer (int32)

Current VIP tier for this root account. A value of 0 is the base tier. Read-only.

Example 1

usernameUnlocked boolean

Whether this account is currently allowed to claim/change a username.

Example false

currentTermsAccepted boolean

Whether the caller's root account accepted the terms required for restricted actions. False when the required terms have not been accepted.

Example false

Possible errors: 5

Key	Status	Error	When
unauthenticated	401	Unauthenticated	Authentication required.
permission-denied	403	Permission Denied	Permission denied.
invalid-argument	400	Invalid Argument	Invalid argument.
not-found	404	Not Found	Not found.
unavailable	503	Unavailable	Service unavailable.

GET

/v1/auth/profile

Request

Testnet

curl --request GET \ \
  --url 'https://api.testnet.polyester.com/v1/auth/profile' \
  --header 'Accept: */*' \
  --header 'X-API-KEY-ID: YOUR_API_KEY_ID' \
  --header 'X-API-TIMESTAMP: YOUR_API_TIMESTAMP' \
  --header 'X-API-SIGNATURE: YOUR_API_SIGNATURE'

Responses

{
  "avatarUrl": "https://placehold.co/128x128.png",
  "bio": "Professional crypto trader and liquidity provider.",
  "createdAt": "2025-01-01T00:00:00Z",
  "currentTermsAccepted": false,
  "discord": "polyester_trader",
  "discordVerified": false,
  "nextUsernameChangeAt": "2025-01-01T00:00:00Z",
  "twitter": "@polyester_exchange",
  "twitterVerified": false,
  "username": "trader_alpha",
  "usernameUnlocked": false,
  "vipTier": 1,
  "website": "https://example.com"
}

Polyester is best experienced on desktop.

Request

Responses