Skip to main content

Signature

client.get_balance(include_summary: bool = False) -> Dict

Parameters

ParameterTypeDescription
include_summaryboolIf True, includes portfolio totals. Default: False

Returns

Basic (include_summary=False):
FieldTypeDescription
balancefloatTotal USDC balance
available_balancefloatAvailable for trading
reserved_balancefloatReserved in open orders
With summary (include_summary=True): adds these fields:
FieldTypeDescription
total_position_valuefloatMarket value of all positions
total_valuefloatTotal portfolio value (balance + positions)
open_orders_countintNumber of open orders
positions_countintNumber of positions

Example

from polyhush import PolyhushClient

client = PolyhushClient(api_key="your-api-key")

# Basic balance
balance = client.get_balance()
print(f"Available: ${balance['available_balance']:.2f}, Reserved: ${balance['reserved_balance']:.2f}")

# Full portfolio summary
summary = client.get_balance(include_summary=True)
print(f"Total portfolio: ${summary['total_value']:.2f}")