Get the authenticated account

The account behind the credential: identifiers, name, how the request authenticated and your public profile (handle, avatar_url, leaderboard_opt_in, handle_changeable_at).

GET

https://demo.stxapp.iohttps://demo.stxapp.cahttps://api.on.stxapp.ca/api/v1/me

Try it ▶

Try it

Base URL

Key ID stx_access_keyPrivate key (PEM or base64 seed) stx_private_key

Request

Send requestShow signed headersClear saved key

Every endpoint, in one place: the full Try it.

Signing happens in your browser with WebCrypto. Your private key is never sent anywhere; Send request sends your key ID and the signature to the demo host above. Only demo hosts are offered. The key ID and private key are saved in this browser's local storage, per jurisdiction, until you click Clear saved key. Use a demo key here, never a production one.

In the SDKs

• TypeScript: STX.me()
• Python: STX.me()
• C#: STXIdentityService.GetMeAsync()

Responses

Status	Description	Schema
200	Success	object
401	No credential, a bad signature, or a bearer token that is expired, invalid or not a member’s. With any signing header present the API-key rules apply and the body is {“error”:“Missing or invalid API key credentials”}; otherwise {“error”:“Unauthorized”}.	Error
403	The account behind this key is not active, for example it is pending approval or suspended. Body: {“error”:“Your account is suspended. Contact support.”}, the message naming the account’s status.	Error

Example

Request:

curl --request GET \
  --url 'https://demo.stxapp.io/api/v1/me' \
  --header 'X-STX-ACCESS-KEY: <key-id>' \
  --header 'X-STX-ACCESS-TIMESTAMP: <unix-ms>' \
  --header 'X-STX-ACCESS-SIGNATURE: <base64-ed25519>'

Response 200:

{
  "me": {
    "account_id": "a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
    "avatar_url": null,
    "first_name": null,
    "handle": null,
    "handle_changeable_at": null,
    "key_id": null,
    "last_name": null,
    "leaderboard_opt_in": false,
    "method": "api_key",
    "scope": null,
    "user_id": "a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d"
  }
}

Response fields

Field	Type	Description
account_id	uuid	Your account id. Trades, settlements and balances are scoped to it.
avatar_url	string	Path of your avatar, /avatars/{handle}.svg, relative to the API host. null when handle is null.
first_name	string	First name on the account, or null if no profile is loaded.
handle	string	Your public handle, shown on the leaderboard in place of your name. null until one is set.
handle_changeable_at	date-time	When you may next change your handle. null means now; otherwise the end of the 30-day window since the last change.
key_id	string	The id of the API key that signed this request: the value sent in the access-key header. null on a bearer request.
last_name	string	Last name on the account, or null if no profile is loaded.
leaderboard_opt_in	boolean	Whether you have consented to appear on public leaderboards. New accounts start with the jurisdiction’s default; accounts from before the leaderboard start at false. Change it with PATCH /api/v1/me/profile.
method	string	How this request authenticated: api_key for a signed request, bearer for a session token.
scope	string	Access level granted to this key: read_only, or read_write for keys that may place and cancel orders. null on a bearer request.
user_id	uuid	Your user id. Substitute this into account channel topics such as orders:{user_id}.