Skip to main content

Account

Resolve the account you trade from. Authenticated keys are one user, one account; get it once and use it for all other requests (orders, positions, search filters). Endpoints that require an account expect the fully qualified resource name in the form firms/{firmId}/accounts/{accountId} — the exact string returned by List accounts (with your firm and account IDs).

Get who-am-I​

POST /api/v1/get_who_am_i

Returns the user information for the caller. Use this to confirm identity before listing accounts.

Key response: user (fully qualified user resource name, e.g. firms/{firmId}/users/{userId}); optional user_display_name, firm, and related fields per spec. Note that when connected as a group account, the user id will take the format of individualAddress:groupAddress.

No request body.

List accounts​

POST /api/v1/list_accounts

Returns the accounts the caller may use to trade. With the current model you have one account; the response includes its fully qualified resource name in the form firms/{firmId}/accounts/{accountId} (with your actual IDs). Use this exact string in all subsequent requests that require an account: order entry, position queries, and search filters.

Key response: accounts (list of resource names), optional display_names.

Request body (optional user to list accounts for a specific user; omit to list all for the caller):

Request with a user filter:

{
  "user": "firms/{firmId}/users/{userId}"
}

Call list accounts (or get who-am-I then list accounts for that user) at startup or when initializing your client. Store the full account name (firms/{firmId}/accounts/{accountId}) and pass it wherever the API requires an account.

List users​

POST /api/v1/list_users

Returns the users the caller may trade on behalf of (for example when using agent-style flows).

Key response: users (fully qualified user names), optional display_names. Request body is an empty object {} unless the spec adds optional filters.

Full request/response shapes: Trader API spec (low-latency).