get_balance
Retrieve the authenticated account snapshot: collateral balance, equity, open positions with per-position risk metrics, and funding paid. Use it to check current balances and position risk before trading.
Instructions
Get the authenticated account snapshot: collateral balance, equity, and positions. Positions carry per-position risk detail. notional_value, margin_used, roe, max_leverage, and leverage are derived from mirrored state, so any of them can be null with a companion <field>_error naming the reason (e.g. mark_price_unavailable); treat null as UNKNOWN, never as zero. leverage is currently always null (leverage_error: margin_state_not_mirrored) — do not infer it from margin_used. funding_paid is NOT one of those: it is always present and has no _error companion, so its "0" is a real zero (no funding accrued), not unknown. It is paid-positive — a negative value means funding was received. Requires API credentials.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||