latestOpenAPI 3.0.32026-08-10336178.7 KB

6b7d8bd51050

Account

Get account info

Returns balances, margin totals, profile data, symbol settings, and active subaccount metadata. A master account response includes its active sub_accounts. Selecting sub_account_id returns that owned subaccount and includes parent_account_id, parent_blockchain_address, and its active siblings. Public account selectors do not require authentication; sub_account_id and the no-selector caller context do. Selector precedence is account_id, vault_id, blockchain address, then authenticated caller/subaccount.

get/v2/account

Query parameters

account_idstring uuid

Public account lookup by UUID. Takes precedence over every other account selector.

sub_account_idstring uuid

Select an active subaccount owned by the authenticated master account. Requires JWT or API-wallet authentication and is used only when account_id, vault_id, and blockchain_address are absent.

vault_idstring

Public vault lookup. Resolves the vault's trading account; ignored when account_id is present.

blockchain'cardano' | 'ethereum' | 'solana'

Blockchain used with blockchain_address for a direct lookup. If omitted, the server infers or searches supported chains.

blockchain_addressstring

Public wallet-address lookup (maximum 512 bytes).

Response

Account information

account_idstring uuid required

Resolved account ID

namestring

Subaccount display name; omitted for a master account

parent_account_idstring uuid

Parent account ID; present for a subaccount

parent_blockchain_addressstring nullable

Parent wallet address; present when available for a subaccount

blockchainstring required

Registered blockchain. Empty for vault accounts and subaccounts.

blockchain_addressstring nullable required

Registered wallet address. Null for subaccounts and empty for vault accounts.

nicknamestring

Public account nickname; omitted when empty

avatar_urlstring uri

Public account avatar URL; omitted when empty

wallet_balancestring required

Wallet balance

available_balancestring required

Balance available for new orders

copy_reserved_balancestring required

Balance reserved by active copy-trading subscriptions

unrealized_pnlstring required

Total unrealized PnL

margin_balancestring required

Wallet balance plus unrealized PnL

total_marginstring required

Total margin currently reserved

position_initial_marginstring required

Initial margin held by positions

maintenance_marginstring required

Maintenance margin requirement

symbol_settingsobject

Per-symbol margin mode and leverage settings.