Skip to main content
GET
/
api
/
v1
/
settlements
Get Settlements
curl --request GET \
  --url https://api.example.com/api/v1/settlements \
  --header 'Content-Type: application/json' \
  --data '
{
  "limit": 123,
  "offset": 123
}
'
{
  "settlements": [
    {
      "market_id": "<string>",
      "market_question": "<string>",
      "winning_outcome": "<string>",
      "winnings": 123,
      "settled_at": "<string>"
    }
  ]
}

​
Usage

settlements = client.get_settlements(limit=50, offset=0)

​
Parameters

​
limit
integer
default:50
Maximum settlements to return (max 100).
​
offset
integer
default:0
Pagination offset.

​
Response

Returns a list of settlement records.
​
settlements
array

​
Example

from polyhush import PolyhushClient

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

settlements = client.get_settlements(limit=20)

print(f"Settlement History ({len(settlements)} records)")
print("=" * 50)

total_winnings = 0
for settlement in settlements:
    total_winnings += settlement['winnings']
    result = "🟢" if settlement['winnings'] > 0 else "🔴"
    
    print(f"\n{result} {settlement['market_question'][:50]}...")
    print(f"   Winner: {settlement['winning_outcome']}")
    print(f"   Payout: ${settlement['winnings']:.2f}")
    print(f"   Date: {settlement['settled_at']}")

print(f"\n{'=' * 50}")
print(f"Total Historical Winnings: ${total_winnings:.2f}")

​
Response

[
  {
    "market_id": "0x1234...abcd",
    "market_question": "Will BTC exceed $100k by end of 2024?",
    "winning_outcome": "Yes",
    "winnings": 100.00,
    "settled_at": "2024-12-31T23:59:00Z"
  },
  {
    "market_id": "0x5678...efgh",
    "market_question": "Will ETH flip BTC in 2024?",
    "winning_outcome": "No",
    "winnings": 0,
    "settled_at": "2024-12-31T23:59:00Z"
  }
]
This shows your complete settlement history, including both winning and losing positions. Use get_settlement_summary() for aggregate statistics.