Skip to main content
GET
Get identity

Authorizations

Authorization
string
header
required

Scoped API key (ttk_...), created in the Totalis app or by a wallet-session user through the API keys routes with a fresh wallet signature; those routes never accept a key. Each key acts for one account, yours or a maker's, and holds only scopes that account can use. Each operation lists the scopes it requires. Send no Origin.

Scopes

identity:read

Response

The account's ID, status, username, avatar seed, X picture, wallet and wallet kind.

account_id
string<uuid>
required

Totalis account ID.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
status
enum<string>
required

Account status: ACTIVE, RESTRICTED (some actions are refused by policy) or CLOSED.

Available options:
ACTIVE,
RESTRICTED,
CLOSED
wallet
string
required

The account's wallet: its Privy embedded wallet, or the one wallet of an account that signs in with an external wallet. It is the account's owner, which signs API-key issuance, and its signer, which signs its financial actions.

Pattern: ^0x[0-9a-f]{40}$
username
string | null

The account's public username and the name of its /r/ link, or null until it picks one with PUT /v1/me/username. It can change. Servers before contract 129 omit it.

Pattern: ^[a-z0-9_]{3,20}$
avatar_seed
string

Random seed assigned when the account is created; the account can change it with PUT /v1/me/avatar. Clients draw the account's generated avatar from it, so the avatar is the same on every device. Servers before contract 134 omit it.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
picture_url
string

The profile picture of the X account linked to the account's Privy login, which clients show in place of the generated avatar, the same on every device. The server reads it from Privy on the first GET /v1/me after each sign-in and on POST /v1/me/picture, and serves what it last read: if Privy does not answer, the earlier picture stays until a later GET /v1/me reads it. Absent when the server has no picture: none is linked, it is not on X's profile picture hosts, it has not been read yet, or the server has no Privy app secret. Servers before contract 186 omit it.

Maximum string length: 512
Pattern: ^https://(pbs\.twimg\.com/profile_images|abs\.twimg\.com/sticky/default_profile_images)(/[A-Za-z0-9_-][A-Za-z0-9._-]*)+$
wallet_kind
enum<string>

EMBEDDED for a Privy embedded wallet, whose free vault cash Totalis moves to HyperCore in the background; EXTERNAL for an account that signs in with an external wallet, which has no such sweep. Servers before contract 147 omit it.

Available options:
EMBEDDED,
EXTERNAL
public_profile
boolean

Whether the account turned on its public trader profile with PUT /v1/me/public-profile. Servers before contract 190 omit it.

x_username
string

The handle of the X account linked to the account's Privy login, read from Privy with picture_url and served the same way. Absent when the server has none: none is linked, X does not allow it, it has not been read yet, or the server has no Privy app secret. Servers before contract 210 omit it.

Pattern: ^[A-Za-z0-9_]{1,15}$
x_shown
boolean

Whether the public trader profile shows x_username: true until the account hides it with PUT /v1/me/public-profile/x, whether or not X is linked. Servers before contract 210 omit it.

genesis
string<date-time>

The account's Genesis Account badge (GET /v1/me/genesis), shown whether or not its public profile is on; absent until it is earned. Servers before contract 227 omit it.

Maximum string length: 30
Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}([.][0-9]{1,9})?Z$