Skip to main content
GET
Get account summary

Headers

x-wallet
string

Wallet address — primary user identification method

x-device-id
string

Device identifier — mobile fallback when x-wallet is not set

Query Parameters

wallet
string

Wallet address — fallback if neither x-wallet nor x-device-id headers are set

Response

Account summary

wallet
string
required
Example:

"GmQozSzrtMjXt5F1Bed8Vrt55zCbiga8vDZr47RX9wC8"

available
integer
required

Available balance in USDC micros

Example:

9500000000

locked
integer
required

Locked balance reserved for resting bid orders (USDC micros)

Example:

500000000

deficit
integer
required

Outstanding settlement shortfall tracked on the account (USDC micros).

Example:

25000000

total_pnl
integer
required

Total P&L derived from balance: (available + locked) - initial_balance (USDC micros).

Example:

250000000

return_pct
number<double>
required

Percentage return: total_pnl / initial_balance * 100.

Example:

2.5

positions
object[]
required
price_decimals
integer
required

Decimals applied to balance/PnL/margin fields (always 6).

Example:

6

quote_asset
string
required

Quote asset of the cash balance (always "USDC").

Example:

"USDC"