Skip to main content
GET
/
api
/
v1
/
settlements
/
summary
Get Settlement Summary
curl --request GET \
  --url https://api.example.com/api/v1/settlements/summary
{
  "total_winnings": 123,
  "settled_markets": 123,
  "pending_markets": 123
}

​
Usage

summary = client.get_settlement_summary()

​
Response

​
total_winnings
number
Sum of all settlement payouts.
​
settled_markets
integer
Number of markets you’ve settled.
​
pending_markets
integer
Number of markets awaiting settlement.

​
Example

from polyhush import PolyhushClient

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

summary = client.get_settlement_summary()

print("📊 Settlement Summary")
print("=" * 30)
print(f"Total Winnings: ${summary['total_winnings']:.2f}")
print(f"Settled Markets: {summary['settled_markets']}")
print(f"Pending Markets: {summary['pending_markets']}")

if summary['pending_markets'] > 0:
    print(f"\n⚠️ You have {summary['pending_markets']} markets to settle!")
    print("Run client.settle_all_positions() to claim your funds.")

​
Response

{
  "total_winnings": 1250.00,
  "settled_markets": 15,
  "pending_markets": 3
}

​
Dashboard Example

def print_dashboard():
    """Print a trading dashboard"""
    client = PolyhushClient(api_key="your-api-key")
    
    # Get all data
    balance = client.get_balance()
    positions = client.get_position_details()
    settlement = client.get_settlement_summary()
    
    # Calculate totals
    position_value = sum(p['market_value'] for p in positions)
    unrealized_pnl = sum(p['unrealized_pnl'] for p in positions)
    
    print("╔════════════════════════════════════╗")
    print("║        TRADING DASHBOARD           ║")
    print("╠════════════════════════════════════╣")
    print(f"║ Cash Balance:     ${balance['balance']:>12.2f} ║")
    print(f"║ Position Value:   ${position_value:>12.2f} ║")
    print(f"║ Unrealized P&L:   ${unrealized_pnl:>12.2f} ║")
    print("╠════════════════════════════════════╣")
    print(f"║ Total Winnings:   ${settlement['total_winnings']:>12.2f} ║")
    print(f"║ Settled Markets:  {settlement['settled_markets']:>12} ║")
    print(f"║ Pending Settles:  {settlement['pending_markets']:>12} ║")
    print("╚════════════════════════════════════╝")

print_dashboard()
Use this for high-level reporting. For detailed settlement history, use get_settlements().